用户
图式
该模式定义了用户记录中存在的所有字段。除非使用“_filter”查询参数或模式字段仅出现在特定上下文中,否则来自这些端点的任何响应都应包含以下字段。
id 整数 | 用户的唯一标识符。 只读 上下文:embed, view,edit |
username 细绳 | 用户的登录名。 语境:edit |
name 细绳 | 用户的显示名称。 上下文:embed, view,edit |
first_name 细绳 | 用户的名字。 语境:edit |
last_name 细绳 | 用户的姓氏。 语境:edit |
email 字符串, 电子邮件 | 用户的电子邮件地址。 语境:edit |
url 字符串, uri | 用户的网址。 上下文:embed, view,edit |
description 细绳 | 用户的描述。 上下文:embed, view,edit |
link 字符串, uri | 用户的作者 URL。 只读 上下文:embed, view,edit |
locale 细绳 | 用户的语言环境。 语境:edit 其中之一:,en_US |
nickname 细绳 | 用户的昵称。 语境:edit |
slug 细绳 | 用户的字母数字标识符。 上下文:embed, view,edit |
registered_date 字符串, 日期时间(详细信息) | 用户的注册日期。 只读 语境:edit |
roles 大批 | 分配给用户的角色。 语境:edit |
password 细绳 | 用户的密码(从不包含)。 语境: |
capabilities 目的 | 分配给用户的所有能力。 只读 语境:edit |
extra_capabilities 目的 | 分配给用户的任何额外能力。 只读 语境:edit |
avatar_urls 目的 | 用户的头像 URL。 只读 上下文:embed, view,edit |
meta 目的 | 元字段。 上下文: view,edit |
列出用户
查询此端点以检索用户集合。可以使用下面的 URL 查询参数控制和过滤您收到的响应。
定义
GET /wp/v2/users
示例请求
$ curl https://example.com/wp-json/wp/v2/users
参数
context | 提出请求的范围;确定响应中存在的字段。 默认:view 其中之一:view, embed,edit |
page | 集合的当前页面。 默认:1 |
per_page | 结果集中要返回的最大项目数。 默认:10 |
search | 将结果限制为与字符串匹配的结果。 |
exclude | 确保结果集排除特定 ID。 |
include | 将结果集限制为特定 ID。 |
offset | 按特定数量的项目偏移结果集。 |
order | Order 排序属性升序或降序。 默认:asc 其中之一:asc,desc |
orderby | 按对象属性对集合进行排序。 默认:name 其中 之一:id,,,,,,,,, include_ name_ _ _registered_datesluginclude_slugsemailurl |
slug | 将结果集限制为具有一个或多个特定 slug 的用户。 |
roles | 将结果集限制为至少匹配所提供的一个特定角色的用户。接受 csv 列表或单一角色。 |
who | 将结果集限制为被视为作者的用户。 之一:authors |
创建用户
参数
username | 用户的登录名。 要求:1 |
name | 用户的显示名称。 |
first_name | 用户的名字。 |
last_name | 用户的姓氏。 |
用户的电子邮件地址。 要求:1 | |
url | 用户的网址。 |
description | 用户的描述。 |
locale | 用户的语言环境。 其中之一:,en_US |
nickname | 用户的昵称。 |
slug | 用户的字母数字标识符。 |
roles | 分配给用户的角色。 |
password | 用户的密码(从不包含)。 要求:1 |
meta | 元字段。 |
定义
POST /wp/v2/users
检索用户
定义和示例请求
GET /wp/v2/users/<id>
查询此端点以检索特定用户记录。
$ curl https://example.com/wp-json/wp/v2/users/<id>
参数
id | 用户的唯一标识符。 |
context | 提出请求的范围;确定响应中存在的字段。 默认:view 其中之一:view, embed,edit |
更新用户
参数
id | 用户的唯一标识符。 |
username | 用户的登录名。 |
name | 用户的显示名称。 |
first_name | 用户的名字。 |
last_name | 用户的姓氏。 |
用户的电子邮件地址。 | |
url | 用户的网址。 |
description | 用户的描述。 |
locale | 用户的语言环境。 其中之一:,en_US |
nickname | 用户的昵称。 |
slug | 用户的字母数字标识符。 |
roles | 分配给用户的角色。 |
password | 用户的密码(从不包含)。 |
meta | 元字段。 |
定义
POST /wp/v2/users/<id>
示例请求
删除用户
参数
id | 用户的唯一标识符。 |
force | 必须为真,因为用户不支持丢弃垃圾。 |
reassign | 将已删除用户的帖子和链接重新分配给该用户 ID。 要求:1 |
定义
DELETE /wp/v2/users/<id>
示例请求
$ curl -X DELETE https://example.com/wp-json/wp/v2/users/<id>
检索用户
定义和示例请求
GET /wp/v2/users/me
查询此端点以检索特定用户记录。
$ curl https://example.com/wp-json/wp/v2/users/me
参数
context | 提出请求的范围;确定响应中存在的字段。 默认:view 其中之一:view, embed,edit |
更新用户
参数
username | 用户的登录名。 |
name | 用户的显示名称。 |
first_name | 用户的名字。 |
last_name | 用户的姓氏。 |
用户的电子邮件地址。 | |
url | 用户的网址。 |
description | 用户的描述。 |
locale | 用户的语言环境。 其中之一:,en_US |
nickname | 用户的昵称。 |
slug | 用户的字母数字标识符。 |
roles | 分配给用户的角色。 |
password | 用户的密码(从不包含)。 |
meta | 元字段。 |
定义
POST /wp/v2/users/me
示例请求
删除用户
参数
force | 必须为真,因为用户不支持丢弃垃圾。 |
reassign | 将已删除用户的帖子和链接重新分配给该用户 ID。 要求:1 |
定义
DELETE /wp/v2/users/me
示例请求
$ curl -X DELETE https://example.com/wp-json/wp/v2/users/me