架构

架构定义了侧边栏记录中存在的所有字段。除非使用了 `_filter` 查询参数,或者该架构字段仅出现在特定上下文中,否则这些端点的任何响应都应包含以下字段。

id 侧边栏的 ID。

JSON 数据类型:字符串

只读

上下文:embed, view, edit

name 标识侧边栏的唯一名称。

JSON 数据类型:字符串

只读

上下文:embed, view, edit

description 侧边栏的描述。

JSON 数据类型:字符串

只读

上下文:embed, view, edit

class 在小工具界面中分配给侧边栏的额外 CSS 类。

JSON 数据类型:字符串

只读

上下文:embed, view, edit

before_widget 当分配到此侧边栏时,在每个小工具的 HTML 输出前添加的 HTML 内容。默认为打开的列表项元素。

JSON 数据类型:字符串

只读

上下文:embed, view, edit

after_widget 当分配到此侧边栏时,在每个小工具的 HTML 输出后附加的 HTML 内容。默认为关闭的列表项元素。

JSON 数据类型:字符串

只读

上下文:embed, view, edit

before_title 显示时添加到侧边栏标题前的 HTML 内容。默认为打开的 h2 元素。

JSON 数据类型:字符串

只读

上下文:embed, view, edit

after_title 显示时添加到侧边栏标题后的 HTML 内容。默认为关闭的 h2 元素。

JSON 数据类型:字符串

只读

上下文:embed, view, edit

status 侧边栏的状态。

JSON 数据类型:字符串

只读

上下文:embed, view, edit

其中之一:active, inactive

widgets 嵌套的小工具。

JSON 数据类型:数组

上下文:embed, view, edit

检索侧边栏

定义与示例请求

GET /wp/v2/sidebars

查询此端点以检索特定的侧边栏记录。

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

参数

context 请求的范围;确定响应中存在的字段。

默认值:view

其中之一:view, embed, edit

检索侧边栏

定义与示例请求

GET /wp/v2/sidebars/<id>

查询此端点以检索特定的侧边栏记录。

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

参数

id 已注册侧边栏的 ID
context 请求的范围;确定响应中存在的字段。

默认值:view

其中之一:view, embed, edit

更新侧边栏

参数

widgets 嵌套的小工具。

定义

POST /wp/v2/sidebars/<id>

示例请求

无