スキーマ

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

title オブジェクトのタイトル。
JSON データ型: 文字列またはオブジェクト
コンテキスト: view, edit, embed
id オブジェクトの一意の識別子。
JSON データ型: 整数
読み取り専用
コンテキスト: view, edit, embed
type_label このタイプのメニュー項目を説明するために使用される単数ラベル。
JSON データ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
type 元々表されていたオブジェクトのファミリー、例えば「post_type」や「taxonomy」。
JSON データ型: 文字列
コンテキスト: view, edit, embed
一つの: taxonomy, post_type, post_type_archive, custom
status オブジェクトの名前付きステータス。
JSON データ型: 文字列
コンテキスト: view, edit, embed
一つの: publish, future, draft, pending, private
parent オブジェクトの親の ID。
JSON データ型: 整数
コンテキスト: view, edit, embed
attr_title このメニュー項目のリンク要素のタイトル属性のテキスト。
JSON データ型: 文字列
コンテキスト: view, edit, embed
classes このメニュー項目のリンク要素のクラス名。
JSON データ型: 配列
コンテキスト: view, edit, embed
description このメニュー項目の説明。
JSON データ型: 文字列
コンテキスト: view, edit, embed
menu_order この項目のメニュー親である nav_menu_item の DB ID、存在しない場合は 0。
JSON データ型: 整数
コンテキスト: view, edit, embed
object 元々表されていたオブジェクトのタイプ、例えば「category」、「post」、または「attachment」。
JSON データ型: 文字列
コンテキスト: view, edit, embed
object_id このメニュー項目が表す元のオブジェクトのデータベース ID、例えば投稿の ID またはカテゴリの term_id。
JSON データ型: 整数
コンテキスト: view, edit, embed
target このメニュー項目のリンク要素のターゲット属性。
JSON データ型: 文字列
コンテキスト: view, edit, embed
一つの: _blank,
url このメニュー項目が指す URL。
JSON データ型: 文字列,
フォーマット: uri

コンテキスト: view, edit, embed
xfn このメニュー項目のリンクに表現された XFN 関係。
JSON データ型: 配列
コンテキスト: view, edit, embed
invalid メニュー項目がもはや存在しないオブジェクトを表すかどうか。
JSON データ型: ブール値
読み取り専用
コンテキスト: view, edit, embed
menus nav_menu タクソノミー内のオブジェクトに割り当てられた用語。
JSON データ型: 整数
コンテキスト: view, edit
meta メタフィールド。
JSON データ型: オブジェクト
コンテキスト: view, edit

Nav_Menu_Items のリスト

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

定義

GET /wp/v2/menu-items

例リクエスト

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

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

一つの: view, embed, edit
page コレクションの現在のページ。
デフォルト: 1
per_page 結果セットに返される最大アイテム数。
デフォルト: 100
search 文字列に一致する結果に制限します。
after 指定された ISO8601 準拠の日付以降に公開された投稿に応答を制限します。
modified_after 指定された ISO8601 準拠の日付以降に修正された投稿に応答を制限します。
before 指定された ISO8601 準拠の日付以前に公開された投稿に応答を制限します。
modified_before 指定された ISO8601 準拠の日付以前に修正された投稿に応答を制限します。
exclude 結果セットから特定の ID を除外します。
include 結果セットを特定の ID に制限します。
offset 結果セットを特定のアイテム数だけオフセットします。
order ソート属性を昇順または降順にします。
デフォルト: asc

一つの: asc, desc
orderby オブジェクト属性でコレクションをソートします。
デフォルト: menu_order

一つの: author, date, id, include, modified, parent, relevance, slug, include_slugs, title, menu_order
search_columns 検索される列名の配列。
slug 特定のスラッグを持つ投稿に結果セットを制限します。
status 一つ以上の特定のステータスが割り当てられた投稿に結果セットを制限します。
デフォルト: publish
tax_relation 複数のタクソノミー間の関係に基づいて結果セットを制限します。
一つの: AND, OR
menus メニュータクソノミーに特定の用語が割り当てられたアイテムに結果セットを制限します。
menus_exclude メニュータクソノミーに特定の用語が割り当てられたアイテムを除外した結果セットに制限します。
menu_order 特定の menu_order 値を持つ投稿に結果セットを制限します。

Nav_Menu_Item を作成する

引数
title オブジェクトのタイトル。
type 元々表されていたオブジェクトのファミリー、例えば「post_type」や「taxonomy」。
デフォルト: custom

一つの: taxonomy, post_type, post_type_archive, custom
status オブジェクトの名前付きステータス。
デフォルト: publish

一つの: publish, future, draft, pending, private
parent オブジェクトの親の ID。
attr_title このメニュー項目のリンク要素のタイトル属性のテキスト。
classes このメニュー項目のリンク要素のクラス名。
description このメニュー項目の説明。
menu_order この項目のメニュー親である nav_menu_item の DB ID、存在しない場合は 0。
デフォルト: 1
object 元々表されていたオブジェクトのタイプ、例えば「category」、「post」、または「attachment」。
object_id このメニュー項目が表す元のオブジェクトのデータベース ID、例えば投稿の ID またはカテゴリの term_id。
target このメニュー項目のリンク要素のターゲット属性。
一つの: _blank,
url このメニュー項目が指す URL。
xfn このメニュー項目のリンクに表現された XFN 関係。
menus nav_menu タクソノミー内のオブジェクトに割り当てられた用語。
meta メタフィールド。

定義

POST /wp/v2/menu-items

Nav_Menu_Item を取得する

定義と例リクエスト

GET /wp/v2/menu-items/<id>

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

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

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

一つの: view, embed, edit

Nav_Menu_Item を更新する

引数
id 投稿の一意な識別子。
title オブジェクトのタイトル。
type 元々表されていたオブジェクトのファミリー、例えば「post_type」や「taxonomy」。
一つの: taxonomy, post_type, post_type_archive, custom
status オブジェクトの名前付きステータス。
一つの: publish, future, draft, pending, private
parent オブジェクトの親の ID。
attr_title このメニュー項目のリンク要素のタイトル属性のテキスト。
classes このメニュー項目のリンク要素のクラス名。
description このメニュー項目の説明。
menu_order この項目のメニュー親である nav_menu_item の DB ID、存在しない場合は 0。
object 元々表されていたオブジェクトのタイプ、例えば「category」、「post」、または「attachment」。
object_id このメニュー項目が表す元のオブジェクトのデータベース ID、例えば投稿の ID またはカテゴリの term_id。
target このメニュー項目のリンク要素のターゲット属性。
一つの: _blank,
url このメニュー項目が指す URL。
xfn このメニュー項目のリンクに表現された XFN 関係。
menus nav_menu タクソノミー内のオブジェクトに割り当てられた用語。
meta メタフィールド。

定義

POST /wp/v2/menu-items/<id>

例リクエスト

Nav_Menu_Item を削除する

引数
id 投稿の一意な識別子。
force ゴミ箱をバイパスして強制的に削除するかどうか。

定義

DELETE /wp/v2/menu-items/<id>

例リクエスト

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