云策 WordPress 开发者社区

REST API 文档

Templates

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

概述

本文档详细介绍了 WordPress 模板的 REST API 端点，包括模板记录的 Schema 定义和 CRUD 操作。Schema 定义了模板的所有字段，如 id、slug、type 等，并说明了其 JSON 数据类型、只读属性和上下文。文档还提供了检索、创建、更新和删除模板的具体 API 端点、参数和示例请求。

关键要点

  • Schema 定义了模板记录的字段，包括 id、slug、theme、type、content、title、description、status、wp_id、has_theme_file、author、modified 和 is_custom，每个字段有 JSON 数据类型、只读状态和上下文（如 view、embed、edit）。
  • 支持通过 GET /wp/v2/templates 和 GET /wp/v2/templates/<id> 检索模板，参数包括 context、wp_id、area 和 post_type。
  • 创建模板使用 POST /wp/v2/templates，必需参数为 slug，可选参数包括 theme、type、content、title、description、status 和 author。
  • 更新模板使用 POST /wp/v2/templates/<id>，参数包括 id、slug、theme、type、content、title、description、status 和 author。
  • 删除模板使用 DELETE /wp/v2/templates/<id>，参数包括 id 和 force。

代码示例

// 检索所有模板
$ curl https://example.com/wp-json/wp/v2/templates

// 创建模板
POST /wp/v2/templates
参数: slug（必需）, theme, type, content, title, description, status, author

// 删除模板
$ curl -X DELETE https://example.com/wp-json/wp/v2/templates/<id>
📄 原文内容

Schema

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

id ID of template.

JSON data type: string

Read only

Context: embed, view, edit
slug Unique slug identifying the template.

JSON data type: string

Context: embed, view, edit
theme Theme identifier for the template.

JSON data type: string

Context: embed, view, edit
type Type of template.

JSON data type: string

Context: embed, view, edit
source Source of template

JSON data type: string

Read only

Context: embed, view, edit
origin Source of a customized template

JSON data type: string

Read only

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

JSON data type: object or string

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

JSON data type: object or string

Context: embed, view, edit
description Description of template.

JSON data type: string

Context: embed, view, edit
status Status of template.

JSON data type: string

Context: embed, view, edit

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

wp_id Post ID.

JSON data type: integer

Read only

Context: embed, view, edit
has_theme_file Theme file exists.

JSON data type: bool

Read only

Context: embed, view, edit
author The ID for the author of the template.

JSON data type: integer

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

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

Read only

Context: view, edit
is_custom Whether a template is a custom template.

JSON data type: bool

Read only

Context: embed, view, edit

Retrieve a Template

Definition & Example Request

GET /wp/v2/templates

Query this endpoint to retrieve a specific template record.

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

Arguments

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

Default: view

One of: view, embed, edit

wp_id Limit to the specified post id.
area Limit to the specified template part area.
post_type Post type to get the templates for.

Create a Template

Arguments

<a href="#schema-slug">slug</a> Unique slug identifying the template.

Required: 1

<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.

Default: publish

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

<a href="#schema-author">author</a> The ID for the author of the template.

Definition

POST /wp/v2/templates

Retrieve a Template

Definition & Example Request

GET /wp/v2/templates/<id>?)[/w%-]+)

Query this endpoint to retrieve a specific template record.

$ curl https://example.com/wp-json/wp/v2/templates/<id>?)[/w%-]+)

Arguments

id The id of a template
context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

Update a Template

Arguments

<a href="#schema-id">id</a> The id of a template
<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.

Definition

POST /wp/v2/templates/<id>?)[/w%-]+)

Example Request

Delete a Template

Arguments

id The id of a template
force Whether to bypass Trash and force deletion.

Definition

DELETE /wp/v2/templates/<id>?)[/w%-]+)

Example Request

$ curl -X DELETE https://example.com/wp-json/wp/v2/templates/<id>?)[/w%-]+)