编辑器区块-WordPress REST API 手册-果果开发

架构

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

`date`	帖子发布的日期（站点时区）。 JSON 数据类型：字符串或 null 格式：datetime (详情) 上下文：`view`, `edit`, `embed`
`date_gmt`	帖子发布的日期（GMT）。 JSON 数据类型：字符串或 null 格式：datetime (详情) 上下文：`view`, `edit`
`guid`	帖子的全局唯一标识符。 JSON 数据类型：对象只读上下文：`view`, `edit`
`id`	帖子的唯一标识符。 JSON 数据类型：整数只读上下文：`view`, `edit`, `embed`
`link`	帖子的 URL。 JSON 数据类型：字符串格式：uri 只读上下文：`view`, `edit`, `embed`
`modified`	帖子最后修改的日期（站点时区）。 JSON 数据类型：字符串格式：datetime (详情) 只读上下文：`view`, `edit`
`modified_gmt`	帖子最后修改的日期（GMT）。 JSON 数据类型：字符串格式：datetime (详情) 只读上下文：`view`, `edit`
`slug`	帖子类型的唯一字母数字标识符。 JSON 数据类型：字符串上下文：`view`, `edit`, `embed`
`status`	帖子的命名状态。 JSON 数据类型：字符串上下文：`view`, `edit` 其中之一：`publish`, `future`, `draft`, `pending`, `private`
`type`	帖子类型。 JSON 数据类型：字符串只读上下文：`view`, `edit`, `embed`
`password`	用于保护访问内容和摘要的密码。 JSON 数据类型：字符串上下文：`edit`
`title`	帖子的标题。 JSON 数据类型：对象上下文：`view`, `edit`, `embed`
`content`	帖子的内容。 JSON 数据类型：对象上下文：`view`, `edit`
`meta`	元数据字段。 JSON 数据类型：对象上下文：`view`, `edit`
`template`	用于显示帖子的主题文件。 JSON 数据类型：字符串上下文：`view`, `edit`

列出编辑器块

查询此端点以检索编辑器块集合。您可以使用以下 URL 查询参数来控制和过滤接收到的响应。

定义

GET /wp/v2/blocks

示例请求

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

参数

`context`	请求的作用域；决定响应中存在的字段。默认值：`view` 其中之一：`view`, `embed`, `edit`
`page`	集合的当前页码。默认值：`1`
`per_page`	结果集中返回的最大项目数。默认值：`10`
`search`	将结果限制为匹配某个字符串的记录。
`after`	将响应限制为在给定 ISO8601 合规日期之后发布的帖子。
`modified_after`	将响应限制为在给定 ISO8601 合规日期之后修改的帖子。
`before`	将响应限制为在给定 ISO8601 合规日期之前发布的帖子。
`modified_before`	将响应限制为在给定 ISO8601 合规日期之前修改的帖子。
`exclude`	确保结果集排除特定的 ID。
`include`	将结果集限制为特定的 ID。
`offset`	按特定数量的项目偏移结果集。
`order`	排序属性的升序或降序排列。默认值：`desc` 其中之一：`asc`, `desc`
`orderby`	按帖子属性对集合进行排序。默认值：`date` 其中之一：`author`, `date`, `id`, `include`, `modified`, `parent`, `relevance`, `slug`, `include_slugs`, `title`
`search_columns`	要搜索的列名数组。
`slug`	将结果集限制为具有一个或多个特定 slug 的帖子。
`status`	将结果集限制为分配了一个或多个状态的帖子。默认值：`publish`

创建编辑器块

参数

`date`	帖子发布的日期（站点时区）。
`date_gmt`	帖子发布的日期（GMT）。
`slug`	帖子类型的唯一字母数字标识符。
`status`	帖子的命名状态。其中之一：`publish`, `future`, `draft`, `pending`, `private`
`password`	用于保护访问内容和摘要的密码。
`title`	帖子的标题。
`content`	帖子的内容。
`meta`	元数据字段。
`template`	用于显示帖子的主题文件。

定义

POST /wp/v2/blocks

检索编辑器块

定义与示例请求

GET /wp/v2/blocks/<id>

查询此端点以检索特定的编辑器块记录。

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

参数

id 帖子的唯一标识符。

context

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

默认值：view

其中之一：view, embed, edit

password 如果帖子受密码保护，则为该密码。

更新编辑器块

参数

`id`	帖子的唯一标识符。
`date`	帖子发布的日期（站点时区）。
`date_gmt`	帖子发布的日期（GMT）。
`slug`	帖子类型的唯一字母数字标识符。
`status`	帖子的命名状态。其中之一：`publish`, `future`, `draft`, `pending`, `private`
`password`	用于保护访问内容和摘要的密码。
`title`	帖子的标题。
`content`	帖子的内容。
`meta`	元数据字段。
`template`	用于显示帖子的主题文件。

定义

POST /wp/v2/blocks/<id>

示例请求

无

删除编辑器块

参数

`id`	帖子的唯一标识符。
`force`	是否绕过回收站并强制删除。

定义

DELETE /wp/v2/blocks/<id>

示例请求

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