云策 WordPress 开发者社区

REST API 文档

模式目录项

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

概述

本文档描述了 WordPress 模式目录项的数据结构和 API 端点。它定义了模式目录项的字段模式，并提供了查询模式目录项的 REST API 接口，包括参数和示例。

关键要点

  • 模式目录项包含多个字段，如 id、title、content、categories、keywords、description、viewport_width 和 block_types，每个字段有 JSON 数据类型和上下文（如 view、edit、embed）。
  • 可以使用 GET /wp/v2/pattern-directory/patterns 端点查询模式目录项集合，支持多种查询参数如 context、page、per_page、search、category、keyword、slug、offset、order 和 orderby 来过滤和排序结果。
  • 字段的显示受 _filter 查询参数或特定上下文影响，例如 block_types 字段仅在 view 和 embed 上下文中出现。

代码示例

$ curl https://example.com/wp-json/wp/v2/pattern-directory/patterns
📄 原文内容

Schema

The schema defines all the fields that exist within a pattern directory item 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 The pattern ID.

JSON data type: integer

Context: view, edit, embed
title The pattern title, in human readable format.

JSON data type: string

Context: view, edit, embed
content The pattern content.

JSON data type: string

Context: view, edit, embed
categories The pattern's category slugs.

JSON data type: array

Context: view, edit, embed
keywords The pattern's keywords.

JSON data type: array

Context: view, edit, embed
description A description of the pattern.

JSON data type: string

Context: view, edit, embed
viewport_width The preferred width of the viewport when previewing a pattern, in pixels.

JSON data type: integer

Context: view, edit, embed
block_types The block types which can use this pattern.

JSON data type: array

Context: view, embed

List Pattern Directory Items

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

Definition

GET /wp/v2/pattern-directory/patterns

Example Request

$ curl https://example.com/wp-json/wp/v2/pattern-directory/patterns

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: 100

search Limit results to those matching a string.
category Limit results to those matching a category ID.
keyword Limit results to those matching a keyword ID.
slug Limit results to those matching a pattern (slug).
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, favorite_count