スキーマ

スキーマは、ユーザーレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_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 結果セットを1つ以上の特定のスラッグを持つユーザーに制限します。
roles 結果セットを、提供された特定の役割のいずれかに一致するユーザーに制限します。csv リストまたは単一の役割を受け入れます。
capabilities 結果セットを、提供された特定の機能のいずれかに一致するユーザーに制限します。csv リストまたは単一の機能を受け入れます。
who 著者と見なされるユーザーに結果セットを制限します。
いずれか: authors
has_published_posts 投稿を公開したユーザーに結果セットを制限します。

ユーザーを作成

引数
username ユーザーのログイン名。
必須: 1
name ユーザーの表示名。
first_name ユーザーの名。
last_name ユーザーの姓。
email ユーザーのメールアドレス。
必須: 1
url ユーザーの 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 ユーザーの姓。
email ユーザーのメールアドレス。
url ユーザーの 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 ユーザーの姓。
email ユーザーのメールアドレス。
url ユーザーの 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