スキーマ
スキーマは、ブロックパターンレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filter
クエリパラメータが使用されるか、スキーマフィールドが特定のコンテキストにのみ表示されない限り、以下のフィールドが含まれることが期待されます。
name |
パターン名。 JSONデータ型: 文字列 読み取り専用 コンテキスト: view , edit , embed |
title |
人間が読みやすい形式のパターンタイトル。 JSONデータ型: 文字列 読み取り専用 コンテキスト: view , edit , embed |
content |
パターンの内容。 JSONデータ型: 文字列 読み取り専用 コンテキスト: view , edit , embed |
description |
パターンの詳細な説明。 JSONデータ型: 文字列 読み取り専用 コンテキスト: view , edit , embed |
viewport_width |
インサータープレビュー用のパターンビューポート幅。 JSONデータ型: 数値 読み取り専用 コンテキスト: view , edit , embed |
inserter |
パターンがインサータに表示されるかどうかを決定します。 JSONデータ型: ブール値 読み取り専用 コンテキスト: view , edit , embed |
categories |
パターンカテゴリのスラッグ。 JSONデータ型: 配列 読み取り専用 コンテキスト: view , edit , embed |
keywords |
パターンのキーワード。 JSONデータ型: 配列 読み取り専用 コンテキスト: view , edit , embed |
block_types |
パターンが使用されることを意図しているブロックタイプ。 JSONデータ型: 配列 読み取り専用 コンテキスト: view , edit , embed |
post_types |
パターンが使用されることを制限されている投稿タイプの配列。 JSONデータ型: 配列 読み取り専用 コンテキスト: view , edit , embed |
template_types |
パターンが適合するテンプレートタイプの配列。 JSONデータ型: 配列 読み取り専用 コンテキスト: view , edit , embed |
source |
パターンの出所(例: core) JSONデータ型: 文字列 読み取り専用 コンテキスト: view , edit , embed いずれか: core , plugin , theme , pattern-directory/core , pattern-directory/theme , pattern-directory/featured |
ブロックパターンの取得
定義と例リクエスト
GET /wp/v2/block-patterns/patterns
このエンドポイントをクエリして、特定のブロックパターンレコードを取得します。
$ curl https://example.com/wp-json/wp/v2/block-patterns/patterns
このエンドポイントには引数はありません。