架构
架构定义了 nav_menu 记录中存在的所有字段。除非使用了 `_filter` 查询参数,或者该架构字段仅出现在特定上下文中,否则预期这些端点的任何响应都将包含以下字段。
id | 术语的唯一标识符。 JSON 数据类型:integer 只读 上下文: |
description | 术语的 HTML 描述。 JSON 数据类型:string 上下文: |
name | 术语的 HTML 标题。 JSON 数据类型:string 上下文: |
slug | 术语的字母数字标识符,在其类型中是唯一的。 JSON 数据类型:string 上下文: |
meta | 元字段。 JSON 数据类型:object 上下文: |
locations | 分配给菜单的位置。 JSON 数据类型:array 上下文: |
auto_add | 是否自动将顶级页面添加到此菜单。 JSON 数据类型:boolean 上下文: |
列出 Nav_Menus
查询此端点以检索 nav_menus 集合。您可以使用以下 URL 查询参数来控制和管理收到的响应。
定义
GET /wp/v2/menus
示例请求
$ curl https://example.com/wp-json/wp/v2/menus
参数
context | 请求的作用域;决定响应中存在的字段。 默认值: 可选值: |
page | 集合的当前页码。 默认值: |
per_page | 结果集中返回的最大项目数。 默认值: |
search | 将结果限制为匹配特定字符串的记录。 |
exclude | 确保结果集排除特定的 ID。 |
include | 将结果集限制为特定的 ID。 |
offset | 按特定数量的项目偏移结果集。 |
order | 排序属性为升序或降序。 默认值: 可选值: |
orderby | 按术语属性对集合进行排序。 默认值: 可选值: |
hide_empty | 是否隐藏未分配给任何帖子的术语。 |
post | 将结果集限制为分配给特定帖子的术语。 |
slug | 将结果集限制为具有一个或多个特定 slug 的术语。 |
创建 Nav_Menu
参数
description | 术语的 HTML 描述。 |
name | 术语的 HTML 标题。 必需:是 |
slug | 术语的字母数字标识符,在其类型中是唯一的。 |
meta | 元字段。 |
locations | 分配给菜单的位置。 |
auto_add | 是否自动将顶级页面添加到此菜单。 |
定义
POST /wp/v2/menus
检索 Nav_Menu
定义 & 示例请求
GET /wp/v2/menus/<id>
查询此端点以检索特定的 nav_menu 记录。
$ curl https://example.com/wp-json/wp/v2/menus/<id>
参数
id | 术语的唯一标识符。 |
context | 请求的作用域;决定响应中存在的字段。 默认值: 可选值: |
更新 Nav_Menu
参数
id | 术语的唯一标识符。 |
description | 术语的 HTML 描述。 |
name | 术语的 HTML 标题。 |
slug | 术语的字母数字标识符,在其类型中是唯一的。 |
meta | 元字段。 |
locations | 分配给菜单的位置。 |
auto_add | 是否自动将顶级页面添加到此菜单。 |
定义
POST /wp/v2/menus/<id>
示例请求
无
删除 Nav_Menu
参数
id | 术语的唯一标识符。 |
force | 必须为 true,因为术语不支持回收站功能。 |
定义
DELETE /wp/v2/menus/<id>
示例请求
$ curl -X DELETE https://example.com/wp-json/wp/v2/menus/<id>