スキーマ
スキーマは、カテゴリレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filter
クエリパラメータが使用されていない限り、以下のフィールドが含まれることが期待されます。また、スキーマフィールドは特定のコンテキストでのみ表示される場合があります。
id |
用語の一意の識別子。 JSONデータ型: 整数 読み取り専用 コンテキスト: view , embed , edit |
count |
用語の公開された投稿の数。 JSONデータ型: 整数 読み取り専用 コンテキスト: view , edit |
description |
用語のHTML説明。 JSONデータ型: 文字列 コンテキスト: view , edit |
link |
用語のURL。 JSONデータ型: 文字列, 形式: uri 読み取り専用 コンテキスト: view , embed , edit |
name |
用語のHTMLタイトル。 JSONデータ型: 文字列 コンテキスト: view , embed , edit |
slug |
用語のタイプに固有の英数字識別子。 JSONデータ型: 文字列 コンテキスト: view , embed , edit |
taxonomy |
用語のタイプ属性。 JSONデータ型: 文字列 読み取り専用 コンテキスト: view , embed , edit いずれか: category |
parent |
親用語のID。 JSONデータ型: 整数 コンテキスト: view , edit |
meta |
メタフィールド。 JSONデータ型: オブジェクト コンテキスト: view , edit |
カテゴリのリスト
このエンドポイントにクエリを送信して、カテゴリのコレクションを取得します。受け取る応答は、以下のURLクエリパラメータを使用して制御およびフィルタリングできます。
定義
例リクエスト
$ curl https://example.com/wp-json/wp/v2/categories
引数
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view いずれか: view , embed , edit |
page |
コレクションの現在のページ。 デフォルト: 1 |
per_page |
結果セットに返される最大アイテム数。 デフォルト: 10 |
search |
文字列に一致する結果に制限します。 |
exclude |
結果セットから特定のIDを除外します。 |
include |
結果セットを特定のIDに制限します。 |
order |
ソート属性を昇順または降順にします。 デフォルト: asc いずれか: asc , desc |
orderby |
用語属性でコレクションをソートします。 デフォルト: name いずれか: id , include , name , slug , include_slugs , term_group , description , count |
hide_empty |
投稿に割り当てられていない用語を非表示にするかどうか。 |
parent |
特定の親に割り当てられた用語に結果セットを制限します。 |
post |
特定の投稿に割り当てられた用語に結果セットを制限します。 |
slug |
1つ以上の特定のスラグを持つ用語に結果セットを制限します。 |
カテゴリを作成
引数
description |
用語のHTML説明。 |
name |
用語のHTMLタイトル。 必須: 1 |
slug |
用語のタイプに固有の英数字識別子。 |
parent |
親用語のID。 |
meta |
メタフィールド。 |
定義
POST /wp/v2/categories
カテゴリを取得
定義と例リクエスト
GET /wp/v2/categories/<id>
このエンドポイントにクエリを送信して、特定のカテゴリレコードを取得します。
$ curl https://example.com/wp-json/wp/v2/categories/<id>
引数
id |
用語の一意の識別子。 |
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view いずれか: view , embed , edit |
カテゴリを更新
引数
id |
用語の一意の識別子。 |
description |
用語のHTML説明。 |
name |
用語のHTMLタイトル。 |
slug |
用語のタイプに固有の英数字識別子。 |
parent |
親用語のID。 |
meta |
メタフィールド。 |
定義
例リクエスト
カテゴリを削除
引数
id |
用語の一意の識別子。 |
force |
必須でtrueである必要があります。用語はごみ箱をサポートしていません。 |
定義
例リクエスト
$ curl -X DELETE https://example.com/wp-json/wp/v2/categories/<id>