架构

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

id 小工具的唯一标识符。

JSON 数据类型:字符串

上下文:view、edit、embed

id_base 小工具的类型。对应于 widget-types 端点中的 ID。

JSON 数据类型:字符串

上下文:view、edit、embed

sidebar 小工具所属的侧边栏。

JSON 数据类型:字符串

上下文:view、edit、embed

rendered 小工具的 HTML 表示形式。

JSON 数据类型:字符串

只读

上下文:view、edit、embed

rendered_form 小工具管理表单的 HTML 表示形式。

JSON 数据类型:字符串

只读

上下文:edit

instance 小工具的配置设置(如果支持)。

JSON 数据类型:对象

上下文:edit

form_data 来自小工具管理表单的 URL 编码表单数据。用于更新不支持 instance 的小工具。仅写。

JSON 数据类型:字符串

上下文:无

获取小工具

定义与示例请求

GET /wp/v2/widgets

查询此端点以获取特定小工具记录。

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

参数

context 请求的作用域;决定响应中存在的字段。

默认值:view

可选值:view、embed、edit

sidebar 要返回小工具的侧边栏。

创建小工具

参数

id 小工具的唯一标识符。
id_base 小工具的类型。对应于 widget-types 端点中的 ID。
sidebar 小工具所属的侧边栏。

必需:1

默认值:wp_inactive_widgets

instance 小工具的配置设置(如果支持)。
form_data 来自小工具管理表单的 URL 编码表单数据。用于更新不支持 instance 的小工具。仅写。

定义

POST /wp/v2/widgets

获取小工具

定义与示例请求

GET /wp/v2/widgets/<id>

查询此端点以获取特定小工具记录。

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

参数

context 请求的作用域;决定响应中存在的字段。

默认值:view

可选值:view、embed、edit

更新小工具

参数

id 小工具的唯一标识符。
id_base 小工具的类型。对应于 widget-types 端点中的 ID。
sidebar 小工具所属的侧边栏。
instance 小工具的配置设置(如果支持)。
form_data 来自小工具管理表单的 URL 编码表单数据。用于更新不支持 instance 的小工具。仅写。

定义

POST /wp/v2/widgets/<id>

示例请求

无

删除小工具

参数

force 是否强制移除小工具,或将其移至非活动侧边栏。

定义

DELETE /wp/v2/widgets/<id>

示例请求

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