云策 WordPress 开发者社区

REST API 文档

编辑器区块

查看官方原文 ↗
💡 云策文档标注

概述

本文档详细介绍了 WordPress REST API 中 Editor Blocks 的架构和端点操作。它定义了区块记录的字段结构，并提供了列表、创建、检索、更新和删除区块的 API 方法。

关键要点

  • Editor Blocks 的架构包含多个字段，如 id、title、content、status、date、slug 等，每个字段都有其 JSON 数据类型、格式和上下文（如 view、edit、embed）。
  • 支持通过 GET /wp/v2/blocks 端点列出区块，可使用查询参数如 context、page、per_page、search、orderby 等进行过滤和分页。
  • 提供创建（POST /wp/v2/blocks）、检索（GET /wp/v2/blocks/<id>）、更新（POST /wp/v2/blocks/<id>）和删除（DELETE /wp/v2/blocks/<id>）区块的端点，每个操作都有相应的参数定义。
  • 字段如 guid、id、link、modified、modified_gmt 是只读的，而其他字段如 title、content、meta 可在编辑上下文中修改。

代码示例

// 列出所有区块的示例请求
$ curl https://example.com/wp-json/wp/v2/blocks

// 检索特定区块的示例请求
$ curl https://example.com/wp-json/wp/v2/blocks/<id>

// 删除区块的示例请求
$ curl -X DELETE https://example.com/wp-json/wp/v2/blocks/<id>

注意事项

  • 使用 _filter 查询参数可以限制响应中的字段，否则默认包含所有架构字段。
  • 某些字段仅在特定上下文（如 edit）中可用，需根据操作需求选择合适的 context 参数。
  • 删除操作支持 force 参数以绕过回收站直接删除，使用时需谨慎。
📄 原文内容

Schema

The schema defines all the fields that exist within a Editor Block record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

date The date the post was published, in the site's timezone.

JSON data type: string or null,
Format: datetime (details)

Context: view, edit, embed
date_gmt The date the post was published, as GMT.

JSON data type: string or null,
Format: datetime (details)

Context: view, edit
guid The globally unique identifier for the post.

JSON data type: object

Read only

Context: view, edit
id Unique identifier for the post.

JSON data type: integer

Read only

Context: view, edit, embed
modified The date the post was last modified, in the site's timezone.

JSON data type: string,
Format: datetime (details)

Read only

Context: view, edit
modified_gmt The date the post was last modified, as GMT.

JSON data type: string,
Format: datetime (details)

Read only

Context: view, edit
slug An alphanumeric identifier for the post unique to its type.

JSON data type: string

Context: view, edit, embed
status A named status for the post.

JSON data type: string

Context: view, edit

One of: publish, future, draft, pending, private

type Type of post.

JSON data type: string

Read only

Context: view, edit, embed
password A password to protect access to the content and excerpt.

JSON data type: string

Context: edit
title The title for the post.

JSON data type: object

Context: view, edit, embed
content The content for the post.

JSON data type: object

Context: view, edit
meta Meta fields.

JSON data type: object

Context: view, edit
template The theme file to use to display the post.

JSON data type: string

Context: view, edit

List Editor Blocks

Query this endpoint to retrieve a collection of Editor Blocks. The response you receive can be controlled and filtered using the URL query parameters below.

Definition

GET /wp/v2/blocks

Example Request

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

Arguments

context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

page Current page of the collection.

Default: 1

per_page Maximum number of items to be returned in result set.

Default: 10

search Limit results to those matching a string.
after Limit response to posts published after a given ISO8601 compliant date.
modified_after Limit response to posts modified after a given ISO8601 compliant date.
before Limit response to posts published before a given ISO8601 compliant date.
modified_before Limit response to posts modified before a given ISO8601 compliant date.
exclude Ensure result set excludes specific IDs.
include Limit result set to specific IDs.
offset Offset the result set by a specific number of items.
order Order sort attribute ascending or descending.

Default: desc

One of: asc, desc

orderby Sort collection by post attribute.

Default: date

One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title

search_columns Array of column names to be searched.
slug Limit result set to posts with one or more specific slugs.
status Limit result set to posts assigned one or more statuses.

Default: publish

Create a Editor Block

Arguments

<a href="#schema-date">date</a> The date the post was published, in the site's timezone.
<a href="#schema-date_gmt">date_gmt</a> The date the post was published, as GMT.
<a href="#schema-slug">slug</a> An alphanumeric identifier for the post unique to its type.
<a href="#schema-status">status</a> A named status for the post.
One of: publish, future, draft, pending, private
<a href="#schema-password">password</a> A password to protect access to the content and excerpt.
<a href="#schema-title">title</a> The title for the post.
<a href="#schema-content">content</a> The content for the post.
<a href="#schema-meta">meta</a> Meta fields.
<a href="#schema-template">template</a> The theme file to use to display the post.

Definition

POST /wp/v2/blocks

Retrieve a Editor Block

Definition & Example Request

GET /wp/v2/blocks/<id>

Query this endpoint to retrieve a specific Editor Block record.

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

Arguments

id Unique identifier for the post.
context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

password The password for the post if it is password protected.

Update a Editor Block

Arguments

<a href="#schema-id">id</a> Unique identifier for the post.
<a href="#schema-date">date</a> The date the post was published, in the site's timezone.
<a href="#schema-date_gmt">date_gmt</a> The date the post was published, as GMT.
<a href="#schema-slug">slug</a> An alphanumeric identifier for the post unique to its type.
<a href="#schema-status">status</a> A named status for the post.
One of: publish, future, draft, pending, private
<a href="#schema-password">password</a> A password to protect access to the content and excerpt.
<a href="#schema-title">title</a> The title for the post.
<a href="#schema-content">content</a> The content for the post.
<a href="#schema-meta">meta</a> Meta fields.
<a href="#schema-template">template</a> The theme file to use to display the post.

Definition

POST /wp/v2/blocks/<id>

Example Request

Delete a Editor Block

Arguments

id Unique identifier for the post.
force Whether to bypass Trash and force deletion.

Definition

DELETE /wp/v2/blocks/<id>

Example Request

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