云策 WordPress 开发者社区

REST API 文档

Template_Part Revisions

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

概述

本文档详细介绍了 WordPress 中 Template_Part 修订版本的 REST API 接口，包括数据结构、端点定义和操作参数。它面向开发者，提供了管理模板部分修订的完整指南，涵盖列表查询、单个检索、删除和自动保存等功能。

关键要点

  • Template_Part 修订记录包含多个字段，如 author、date、content、title 等，每个字段有特定的 JSON 数据类型和上下文（view、edit、embed）。
  • 支持通过 GET /wp/v2/template-parts/<parent>/revisions 端点列出修订版本，可使用参数如 context、page、orderby 进行过滤和排序。
  • 提供 GET /wp/v2/template-parts/<parent>/revisions/<id> 端点检索单个修订，以及 DELETE 端点删除修订（需 force 参数）。
  • 自动保存功能通过 POST /wp/v2/template-parts/<id>/autosaves 创建修订，并支持 GET 端点检索自动保存记录。
  • 所有操作都依赖于 parent 和 id 参数来指定模板部分和修订，确保数据准确关联。

代码示例

// 列出模板部分修订
$ curl https://example.com/wp-json/wp/v2/template-parts/<parent>/revisions

// 检索特定修订
$ curl https://example.com/wp-json/wp/v2/template-parts/<parent>/revisions/<id>

// 删除修订
$ curl -X DELETE https://example.com/wp-json/wp/v2/template-parts/<parent>/revisions/<id>

// 创建自动保存
$ curl -X POST https://example.com/wp-json/wp/v2/template-parts/<id>/autosaves
📄 原文内容

Schema

The schema defines all the fields that exist within a template_part revision 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.

author The ID for the author of the revision.

JSON data type: integer

Context: view, edit, embed
date The date the revision was published, in the site's timezone.

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

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

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

Context: view, edit
guid GUID for the revision, as it exists in the database.

JSON data type: string

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

JSON data type: integer

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

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

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

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

Context: view, edit
parent The ID for the parent of the revision.

JSON data type: integer

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

JSON data type: string

Context: view, edit, embed
title Title of template.

JSON data type: object or string

Context: embed, view, edit
content Content of template.

JSON data type: object or string

Context: embed, view, edit

List Template_Part Revisions

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

Definition

GET /wp/v2/template-parts/<parent>/revisions

Example Request

$ curl https://example.com/wp-json/wp/v2/template-parts/<parent>/revisions

Arguments

parent The ID for the parent of the revision.
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.
search Limit results to those matching a string.
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 object attribute.

Default: date

One of: date, id, include, relevance, slug, include_slugs, title

Retrieve a Template_Part Revision

Definition & Example Request

GET /wp/v2/template-parts/<parent>/revisions/<id>

Query this endpoint to retrieve a specific template_part revision record.

$ curl https://example.com/wp-json/wp/v2/template-parts/<parent>/revisions/<id>

Arguments

parent The ID for the parent of the revision.
id Unique identifier for the revision.
context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

Delete a Template_Part Revision

Arguments

parent The ID for the parent of the revision.
id Unique identifier for the revision.
force Required to be true, as revisions do not support trashing.

Definition

DELETE /wp/v2/template-parts/<parent>/revisions/<id>

Example Request

$ curl -X DELETE https://example.com/wp-json/wp/v2/template-parts/<parent>/revisions/<id>

Retrieve a Template_Part Revision

Definition & Example Request

GET /wp/v2/template-parts/<id>/autosaves

Query this endpoint to retrieve a specific template_part revision record.

$ curl https://example.com/wp-json/wp/v2/template-parts/<id>/autosaves

Arguments

parent The ID for the parent of the autosave.
context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

Create a Template_Part Revision

Arguments

<a href="#schema-parent">parent</a> The ID for the parent of the autosave.
<a href="#schema-slug">slug</a> Unique slug identifying the template.
<a href="#schema-theme">theme</a> Theme identifier for the template.
<a href="#schema-type">type</a> Type of template.
<a href="#schema-content">content</a> Content of template.
<a href="#schema-title">title</a> Title of template.
<a href="#schema-description">description</a> Description of template.
<a href="#schema-status">status</a> Status of template.
One of: publish, future, draft, pending, private
<a href="#schema-author">author</a> The ID for the author of the template.
<a href="#schema-area">area</a> Where the template part is intended for use (header, footer, etc.)

Definition

POST /wp/v2/template-parts/<id>/autosaves

Retrieve a Template_Part Revision

Definition & Example Request

GET /wp/v2/template-parts/<parent>/autosaves/<id>

Query this endpoint to retrieve a specific template_part revision record.

$ curl https://example.com/wp-json/wp/v2/template-parts/<parent>/autosaves/<id>

Arguments

parent The ID for the parent of the autosave.
id The ID for the autosave.
context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit