架构

该架构定义了 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 此菜单项链接元素的 title 属性的文本。

JSON 数据类型:字符串

上下文:view、edit、embed

classes 此菜单项链接元素的类名。

JSON 数据类型:数组

上下文:view、edit、embed

description 此菜单项的描述。

JSON 数据类型:字符串

上下文:view、edit、embed

menu_order 作为此项菜单父级的 nav_menu_item 的数据库 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 此菜单项链接元素的 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 将结果集限制为具有一个或多个特定 slug 的文章。
status 将结果集限制为被分配了一个或多个状态的文章。

默认值:publish

tax_relation 基于多个分类法之间的关系限制结果集。
之一:AND、OR
menus 将结果集限制为在 menus 分类法中被分配了特定术语的项目。
menus_exclude 将结果集限制为除了那些在 menus 分类法中被分配了特定术语之外的项目。
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 此菜单项链接元素的 title 属性的文本。
classes 此菜单项链接元素的类名。
description 此菜单项的描述。
menu_order 作为此项菜单父级的 nav_menu_item 的数据库 ID(如果有),否则为 0。

默认值:1

object 原始表示的对象类型,例如“category"、"post"或"attachment"。
object_id 该菜单项所代表的原始对象的数据库 ID,例如文章的 ID 或分类法的 term_id。
target 该菜单项链接元素的 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 该菜单项链接元素的 title 属性文本。
classes 该菜单项链接元素类名。
description 该菜单项的描述。
menu_order 作为该项目菜单父级的 nav_menu_item 的 DB ID(如果存在),否则为 0。
object 原始表示的对象类型,例如"category"、"post"或"attachment"。
object_id 该菜单项所代表的原始对象的数据库 ID,例如文章的 ID 或分类法的 term_id。
target 该菜单项链接元素的 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>