架构

架构定义了用户记录中存在的所有字段。除非使用了 `_filter` 查询参数，或者该架构字段仅出现在特定上下文中，否则这些端点的任何响应都应包含以下字段。

id 用户的唯一标识符。

JSON 数据类型：整数

只读

上下文：embed, view, edit

username 用户的登录名。

JSON 数据类型：字符串

上下文：edit

name 用户的显示名称。

JSON 数据类型：字符串

上下文：embed, view, edit

first_name 用户的名字。

JSON 数据类型：字符串

上下文：edit

last_name 用户的姓氏。

JSON 数据类型：字符串

上下文：edit

email 用户的电子邮件地址。

JSON 数据类型：字符串,
格式：email

上下文：edit

url 用户的 URL。

JSON 数据类型：字符串,
格式：uri

上下文：embed, view, edit

description 用户的描述。

JSON 数据类型：字符串

上下文：embed, view, edit

link 用户的作者 URL。

JSON 数据类型：字符串,
格式：uri

只读

上下文：embed, view, edit

locale 用户的区域设置。

JSON 数据类型：字符串

上下文：edit

其中之一：无, en_US

nickname 用户的昵称。

JSON 数据类型：字符串

上下文：edit

slug 用户的字母数字标识符。

JSON 数据类型：字符串

上下文：embed, view, edit

registered_date 用户的注册日期。

JSON 数据类型：字符串,
格式：datetime (详细信息)

只读

上下文：edit

roles 分配给用户的角色。

JSON 数据类型：数组

上下文：edit

password 用户的密码（永不包含）。

JSON 数据类型：字符串

上下文：无

capabilities 分配给用户的所有权限。

JSON 数据类型：对象

只读

上下文：edit

extra_capabilities 分配给用户的其他权限。

JSON 数据类型：对象

只读

上下文：edit

avatar_urls 用户的头像 URL。

JSON 数据类型：对象

只读

上下文：embed, view, edit

meta 元字段。

JSON 数据类型：对象

上下文：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 排序属性的升序或降序。

默认值：asc

其中之一：asc, desc

orderby 按用户属性对集合进行排序。

默认值：name

其中之一：id, include, name, registered_date, slug, include_slugs, email, url

slug 将结果集限制为具有一个或多个特定 slug 的用户。
roles 将结果集限制为匹配至少一个指定角色的用户。接受 csv 列表或单个角色。
capabilities 将结果集限制为匹配至少一个指定权限的用户。接受 csv 列表或单个权限。
who 将结果集限制为被视为作者的用户。
其中之一：authors
has_published_posts 将结果集限制为拥有已发布文章的用户。

创建用户

参数

username 用户的登录名。

必填：是

name 用户的显示名称。
first_name 用户的名字。
last_name 用户的姓氏。
email 用户的电子邮件地址。

必填：是

url 用户的 URL。
description 用户的描述。
locale 用户的区域设置。
其中之一：无, en_US
nickname 用户的昵称。
slug 用户的字母数字标识符。
roles 分配给用户的角色。
password 用户的密码（永不包含）。

必填：是

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 用户的姓氏。
email 用户的电子邮件地址。
url 用户的 URL。
description 用户的描述。
locale 用户的区域设置。
其中之一：无, en_US
nickname 用户的昵称。
slug 用户的字母数字标识符。
roles 分配给用户的角色。
password 用户的密码（永不包含）。
meta 元字段。

定义

POST /wp/v2/users/<id>

示例请求

无

删除用户

参数

id 用户的唯一标识符。
force 必须为 true，因为用户不支持移至回收站。
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 用户的姓。
email 用户的电子邮件地址。
url 用户的 URL。
description 用户的描述。
locale 用户的区域设置。
可选值：无, en_US
nickname 用户的昵称。
slug 用户的字母数字标识符。
roles 分配给用户的角色。
password 用户的密码（永不包含）。
meta 元数据字段。

定义

POST /wp/v2/users/me

示例请求

无

删除用户

参数

force 必须为 true，因为用户不支持移至回收站。
reassign 将已删除用户的帖子和链接重新分配到此用户 ID。

必需：1

定义

DELETE /wp/v2/users/me

示例请求

$ curl -X DELETE https://example.com/wp-json/wp/v2/users/me