スキーマ
スキーマは、ブロックタイプレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filter
クエリパラメータが使用されるか、スキーマフィールドが特定のコンテキストにのみ表示されない限り、以下のフィールドが含まれることが期待されます。
api_version |
ブロックAPIのバージョン。 JSONデータタイプ: 整数 読み取り専用 コンテキスト: embed , view , edit |
title |
ブロックタイプのタイトル。 JSONデータタイプ: 文字列 読み取り専用 コンテキスト: embed , view , edit |
name |
ブロックタイプを識別するユニークな名前。 JSONデータタイプ: 文字列 読み取り専用 コンテキスト: embed , view , edit |
description |
ブロックタイプの説明。 JSONデータタイプ: 文字列 読み取り専用 コンテキスト: embed , view , edit |
icon |
ブロックタイプのアイコン。 JSONデータタイプ: 文字列またはnull 読み取り専用 コンテキスト: embed , view , edit |
attributes |
ブロック属性。 JSONデータタイプ: オブジェクトまたはnull 読み取り専用 コンテキスト: embed , view , edit |
provides_context |
このタイプのブロックによって提供されるコンテキスト。 JSONデータタイプ: オブジェクト 読み取り専用 コンテキスト: embed , view , edit |
uses_context |
このタイプのブロックによって継承されるコンテキスト値。 JSONデータタイプ: 配列 読み取り専用 コンテキスト: embed , view , edit |
selectors |
カスタムCSSセレクタ。 JSONデータタイプ: オブジェクト 読み取り専用 コンテキスト: embed , view , edit |
supports |
ブロックサポート。 JSONデータタイプ: オブジェクト 読み取り専用 コンテキスト: embed , view , edit |
category |
ブロックカテゴリ。 JSONデータタイプ: 文字列またはnull 読み取り専用 コンテキスト: embed , view , edit |
is_dynamic |
ブロックは動的にレンダリングされますか。 JSONデータタイプ: ブール値 読み取り専用 コンテキスト: embed , view , edit |
editor_script_handles |
エディタースクリプトハンドル。 JSONデータタイプ: 配列 読み取り専用 コンテキスト: embed , view , edit |
script_handles |
公開向けおよびエディタースクリプトハンドル。 JSONデータタイプ: 配列 読み取り専用 コンテキスト: embed , view , edit |
view_script_handles |
公開向けスクリプトハンドル。 JSONデータタイプ: 配列 読み取り専用 コンテキスト: embed , view , edit |
editor_style_handles |
エディタースタイルハンドル。 JSONデータタイプ: 配列 読み取り専用 コンテキスト: embed , view , edit |
style_handles |
公開向けおよびエディタースタイルハンドル。 JSONデータタイプ: 配列 読み取り専用 コンテキスト: embed , view , edit |
styles |
ブロックスタイルのバリエーション。 JSONデータタイプ: 配列 読み取り専用 コンテキスト: embed , view , edit |
variations |
ブロックのバリエーション。 JSONデータタイプ: 配列 読み取り専用 コンテキスト: embed , view , edit |
textdomain |
公開テキストドメイン。 JSONデータタイプ: 文字列またはnull 読み取り専用 コンテキスト: embed , view , edit |
parent |
親ブロック。 JSONデータタイプ: 配列またはnull 読み取り専用 コンテキスト: embed , view , edit |
ancestor |
祖先ブロック。 JSONデータタイプ: 配列またはnull 読み取り専用 コンテキスト: embed , view , edit |
keywords |
ブロックキーワード。 JSONデータタイプ: 配列 読み取り専用 コンテキスト: embed , view , edit |
example |
ブロックの例。 JSONデータタイプ: オブジェクトまたはnull 読み取り専用 コンテキスト: embed , view , edit |
editor_script |
エディタースクリプトハンドル。非推奨: editor_script_handles を代わりに使用してください。JSONデータタイプ: 文字列またはnull 読み取り専用 コンテキスト: embed , view , edit |
script |
公開向けおよびエディタースクリプトハンドル。非推奨: script_handles を代わりに使用してください。JSONデータタイプ: 文字列またはnull 読み取り専用 コンテキスト: embed , view , edit |
view_script |
公開向けスクリプトハンドル。非推奨: view_script_handles を代わりに使用してください。JSONデータタイプ: 文字列またはnull 読み取り専用 コンテキスト: embed , view , edit |
editor_style |
エディタースタイルハンドル。非推奨: editor_style_handles を代わりに使用してください。JSONデータタイプ: 文字列またはnull 読み取り専用 コンテキスト: embed , view , edit |
style |
公開向けおよびエディタースタイルハンドル。非推奨: style_handles を代わりに使用してください。JSONデータタイプ: 文字列またはnull 読み取り専用 コンテキスト: embed , view , edit |
ブロックタイプの取得
定義と例リクエスト
GET /wp/v2/block-types
このエンドポイントをクエリして、特定のブロックタイプレコードを取得します。
$ curl https://example.com/wp-json/wp/v2/block-types
引数
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view 次のいずれか: view , embed , edit |
namespace |
ブロックネームスペース。 |
ブロックタイプの取得
定義と例リクエスト
GET /wp/v2/block-types/<namespace>
このエンドポイントをクエリして、特定のブロックタイプレコードを取得します。
$ curl https://example.com/wp-json/wp/v2/block-types/<namespace>
引数
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view 次のいずれか: view , embed , edit |
namespace |
ブロックネームスペース。 |
ブロックタイプの取得
定義と例リクエスト
GET /wp/v2/block-types/<namespace>/<name>
このエンドポイントをクエリして、特定のブロックタイプレコードを取得します。
$ curl https://example.com/wp-json/wp/v2/block-types/<namespace>/<name>
引数
name |
ブロック名。 |
namespace |
ブロックネームスペース。 |
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view 次のいずれか: view , embed , edit |