スキーマ

スキーマは、nav_menu レコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filter クエリパラメータが使用されていない限り、以下のフィールドが含まれることが期待されます。また、スキーマフィールドは特定のコンテキストでのみ表示される場合があります。

id 用語の一意の識別子。
JSON データ型: 整数
読み取り専用
コンテキスト: view, embed, edit
description 用語の HTML 説明。
JSON データ型: 文字列
コンテキスト: view, edit
name 用語の HTML タイトル。
JSON データ型: 文字列
コンテキスト: view, embed, edit
slug 用語のタイプに固有の英数字識別子。
JSON データ型: 文字列
コンテキスト: view, embed, edit
meta メタフィールド。
JSON データ型: オブジェクト
コンテキスト: view, edit
locations メニューに割り当てられた場所。
JSON データ型: 配列
コンテキスト: view, edit
auto_add このメニューにトップレベルページを自動的に追加するかどうか。
JSON データ型: ブール値
コンテキスト: view, edit

ナビメニューのリスト

このエンドポイントをクエリして、nav_menus のコレクションを取得します。受け取る応答は、以下の URL クエリパラメータを使用して制御およびフィルタリングできます。

定義

GET /wp/v2/menus

例リクエスト

$ curl https://example.com/wp-json/wp/v2/menus

引数
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, slug, include_slugs, term_group, description, count
hide_empty 投稿に割り当てられていない用語を非表示にするかどうか。
post 特定の投稿に割り当てられた用語に結果セットを制限します。
slug 1 つ以上の特定のスラグを持つ用語に結果セットを制限します。

ナビメニューを作成

引数
description 用語の HTML 説明。
name 用語の HTML タイトル。
必須: 1
slug 用語のタイプに固有の英数字識別子。
meta メタフィールド。
locations メニューに割り当てられた場所。
auto_add このメニューにトップレベルページを自動的に追加するかどうか。

定義

POST /wp/v2/menus

ナビメニューを取得

定義と例リクエスト

GET /wp/v2/menus/<id>

このエンドポイントをクエリして、特定の nav_menu レコードを取得します。

$ curl https://example.com/wp-json/wp/v2/menus/<id>

引数
id 用語の一意の識別子。
context リクエストが行われるスコープ; 応答に存在するフィールドを決定します。
デフォルト: view

一つの: view, embed, edit

ナビメニューを更新

引数
id 用語の一意の識別子。
description 用語の HTML 説明。
name 用語の HTML タイトル。
slug 用語のタイプに固有の英数字識別子。
meta メタフィールド。
locations メニューに割り当てられた場所。
auto_add このメニューにトップレベルページを自動的に追加するかどうか。

定義

POST /wp/v2/menus/<id>

例リクエスト

ナビメニューを削除

引数
id 用語の一意の識別子。
force 必要な場合は真である必要があります。用語はごみ箱をサポートしていません。

定義

DELETE /wp/v2/menus/<id>

例リクエスト

$ curl -X DELETE https://example.com/wp-json/wp/v2/menus/<id>