Пользователи (users)

Эти маршруты позволяют получить/создать/обновить/удалить всевозможные данные юзеров в WP.

А также с версии WP 5.6, появились маршруты которые позволяют получить/создать/обновить/удалить пароли приложений конкретного уюзера.

Возможные маршруты (конечные точки маршрутов описаны ниже):

/wp/v2/users                     // работает со всеми юзерами
/wp/v2/users/{ID}                // работает с указанным юзером
/wp/v2/users/me                  // работает с текущим юзером

/wp/v2/users/{ID}/application-passwords // работает с указанным юзером
/wp/v2/users/me/application-passwords   // работает с текущим юзером

/wp/v2/users/{ID}/application-passwords/uuid
/wp/v2/users/me/application-passwords/uuid

Схема

Схема показывает все поля, которые существуют для объекта: поля объекта которые вернет запрос.

Ресурс Users

Параметр	Контекст	Описание
id Число readonly	embed, view, edit	Уникальный идентификатор пользователя.
username Строка required	edit	Имя входа для пользователя.
name Строка	embed, view, edit	Отображаемое имя пользователя.
first_name Строка	edit	Имя пользователя.
last_name Строка	edit	Фамилия пользователя.
email Строка required	edit	Адрес email пользователя.
url Строка	embed, view, edit	URL пользователя.
description Строка	embed, view, edit	Описание пользователя.
link Строка readonly	embed, view, edit	URL автора для пользователя.
locale Строка	edit	Локаль для пользователя.
nickname Строка	edit	Ник пользователя.
slug Строка	embed, view, edit	Буквенно-цифровой идентификатор пользователя.
registered_date Строка readonly	edit	Дата регистрации пользователя.
roles Массив	edit	Роли назначенные пользователю.
password Строка required		Пароль пользователя (никогда не показывается).
capabilities Объект readonly	edit	Все возможности назначенные пользователю.
extra_capabilities Объект readonly	edit	Любые дополнительные возможности назначенные пользователю.
avatar_urls Объект readonly	embed, view, edit	URL аватара пользователя.
meta Объект	view, edit	Мета поля.

Ресурс Application Passwords

Параметр	Контекст	Описание
uuid Строка readonly	view, edit, embed	Уникальный идентификатор для пароля приложения.
app_id Строка	view, edit, embed	UUID предоставляемый приложением для уникальной идентификации. Рекомендуется использовать UUID v5 с пространством имен URL или DNS.
name Строка required	view, edit, embed	Название пароля приложения.
password Строка readonly	edit	Создаваемый пароль. Доступен после добавления приложения.
created Строка readonly	view, edit	Дата и время (GMT) создания пароля приложения.
last_used Строка/null readonly	view, edit	Дата и время (GMT) последнего использования пароля приложения.
last_ip Строка/null readonly	view, edit	IP-адрес, с которого последний раз использовался пароль приложения.

Список юзеров

Алгоритм схож с работой функции get_users().

Вид запроса

Доступ: публичный

GET /wp/v2/users

Параметры запроса

context(string)

Рамки в которых сделан запрос, определяют поля в ответе.
Может быть: view, embed, edit.
По умолчанию: view

page(integer)

Текущая страница коллекции.
По умолчанию: 1

per_page(integer)

Максимальное число объектов возвращаемое в выборке.
По умолчанию: 10

search(string)

Ограничить результаты до совпадающих со строкой.

exclude(array)

Исключить из выборки определенные ID. Указывается массив ID.
По умолчанию: []

include(array)

Ограничить выборку до определенных ID. Указывается массив ID.
По умолчанию: []

offset(integer)

Сдвиг выборки на определенное число объектов.

order(string)

Сортировать по возрастанию (asc) или убыванию (desc).
Может быть: asc, desc
По умолчанию: asc

orderby(string)

Поле по которому нужно сортировать коллекцию.
Может быть: id, include, name, registered_date, slug, include_slugs, email, url.
По умолчанию: name

slug(array)

Ярлык пользователя которого нужно получить. Можно указать несколько ярлыков в массиве.

roles(array)

Получить пользователй с указанной ролью. Можно указать несколько ролей в массиве. Можно указать CSV список или одну роль.

who(string)

Ограничить выборку пользователями-авторами.
Может быть: authors.

Создание юзера

Алгоритм схож с работой функции wp_create_user().

Вид запроса

Доступ: нужна авторизация

POST /wp/v2/users

Параметры запроса

<dl>
<dt>username<em>(строка) (обязательный)</em>  </dt>
<dd>Имя входа для пользователя.</dd>
<dt>email<em>(строка) (обязательный)</em> </dt>
<dd>Адрес e-mail пользователя.</dd>
<dt>password<em>(строка) (обязательный)</em>  </dt>
<dd>Пароль пользователя (никогда не показывается).</dd>
<dt>name<em>(строка)</em> </dt>
<dd>Отображаемое имя пользователя.</dd>
<dt>first_name<em>(строка)</em>   </dt>
<dd>Имя пользователя.</dd>
<dt>last_name<em>(строка)</em>    </dt>
<dd>Фамилия пользователя.</dd>
<dt>url<em>(строка)</em>  </dt>
<dd>URL пользователя.</dd>
<dt>description<em>(строка)</em>  </dt>
<dd>Описание пользователя.</dd>
<dt>locale<em>(строка)</em>   </dt>
<dd>Локаль для пользователя. Может быть: <var>'', en_US, ru_RU, uk</var>.</dd>
<dt>nickname<em>(строка)</em> </dt>
<dd>Ник пользователя.</dd>
<dt>slug<em>(строка)</em> </dt>
<dd>Буквенно-цифровой идентификатор пользователя.</dd>
<dt>roles<em>(массив)</em>    </dt>
<dd>Роли назначенные пользователю. Указывается массив ролей.</dd>
<dt>meta<em>(объект)</em> </dt>
<dd>Мета поля.</dd>
</dl>

Получение юзера

Алгоритм схож с работой функции get_userdata().

Вид запроса

Доступ: публичный

GET /wp/v2/users/{id}