スキーマ

スキーマは、Editor Block レコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filter クエリパラメータが使用されていない限り、以下のフィールドが含まれることが期待されます。また、スキーマフィールドは特定のコンテキストでのみ表示される場合があります。

date 投稿が公開された日付、サイトのタイムゾーンでの表示。
JSON データ型: 文字列または null,
フォーマット: 日時 ( 詳細)

コンテキスト: view, edit, embed
date_gmt 投稿が公開された日付、GMT 表示。
JSON データ型: 文字列または null,
フォーマット: 日時 ( 詳細)

コンテキスト: view, edit
guid 投稿のグローバルに一意な識別子。
JSON データ型: オブジェクト
読み取り専用
コンテキスト: view, edit
id 投稿の一意な識別子。
JSON データ型: 整数
読み取り専用
コンテキスト: view, edit, embed
link 投稿の URL。
JSON データ型: 文字列,
フォーマット: uri

読み取り専用
コンテキスト: view, edit, embed
modified 投稿が最後に修正された日付、サイトのタイムゾーンでの表示。
JSON データ型: 文字列,
フォーマット: 日時 ( 詳細)

読み取り専用
コンテキスト: view, edit
modified_gmt 投稿が最後に修正された日付、GMT 表示。
JSON データ型: 文字列,
フォーマット: 日時 ( 詳細)

読み取り専用
コンテキスト: view, edit
slug 投稿のタイプに固有の英数字識別子。
JSON データ型: 文字列
コンテキスト: view, edit, embed
status 投稿の名前付きステータス。
JSON データ型: 文字列
コンテキスト: view, edit
一つの: publish, future, draft, pending, private
type 投稿のタイプ。
JSON データ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
password コンテンツと抜粋へのアクセスを保護するためのパスワード。
JSON データ型: 文字列
コンテキスト: edit
title 投稿のタイトル。
JSON データ型: オブジェクト
コンテキスト: view, edit, embed
content 投稿の内容。
JSON データ型: オブジェクト
コンテキスト: view, edit
meta メタフィールド。
JSON データ型: オブジェクト
コンテキスト: view, edit
template 投稿を表示するために使用するテーマファイル。
JSON データ型: 文字列
コンテキスト: view, edit

エディターブロックのリスト

このエンドポイントをクエリして、エディターブロックのコレクションを取得します。受け取る応答は、以下の URL クエリパラメータを使用して制御およびフィルタリングできます。

定義

GET /wp/v2/blocks

例リクエスト

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

引数
context リクエストが行われるスコープ; 応答に含まれるフィールドを決定します。
デフォルト: view

一つの: view, embed, edit
page コレクションの現在のページ。
デフォルト: 1
per_page 結果セットに返される最大アイテム数。
デフォルト: 10
search 文字列に一致する結果を制限します。
after 指定された ISO8601 準拠の日付以降に公開された投稿に応答を制限します。
modified_after 指定された ISO8601 準拠の日付以降に修正された投稿に応答を制限します。
before 指定された ISO8601 準拠の日付以前に公開された投稿に応答を制限します。
modified_before 指定された ISO8601 準拠の日付以前に修正された投稿に応答を制限します。
exclude 結果セットから特定の ID を除外します。
include 結果セットを特定の ID に制限します。
offset 結果セットを特定のアイテム数だけオフセットします。
order ソート属性を昇順または降順にします。
デフォルト: desc

一つの: asc, desc
orderby 投稿属性でコレクションをソートします。
デフォルト: date

一つの: author, date, id, include, modified, parent, relevance, slug, include_slugs, title
search_columns 検索される列名の配列。
slug 一つ以上の特定のスラッグを持つ投稿に結果セットを制限します。
status 一つ以上のステータスが割り当てられた投稿に結果セットを制限します。
デフォルト: publish

エディターブロックを作成

引数
date 投稿が公開された日付、サイトのタイムゾーンでの表示。
date_gmt 投稿が公開された日付、GMT 表示。
slug 投稿のタイプに固有の英数字識別子。
status 投稿の名前付きステータス。
一つの: publish, future, draft, pending, private
password コンテンツと抜粋へのアクセスを保護するためのパスワード。
title 投稿のタイトル。
content 投稿の内容。
meta メタフィールド。
template 投稿を表示するために使用するテーマファイル。

定義

POST /wp/v2/blocks

エディターブロックを取得

定義と例リクエスト

GET /wp/v2/blocks/<id>

このエンドポイントをクエリして、特定のエディターブロックレコードを取得します。

$ curl https://example.com/wp-json/wp/v2/blocks/<id>

引数
id 投稿の一意な識別子。
context リクエストが行われるスコープ; 応答に含まれるフィールドを決定します。
デフォルト: view

一つの: view, embed, edit
password 投稿がパスワードで保護されている場合のパスワード。

エディターブロックを更新

引数
id 投稿の一意な識別子。
date 投稿が公開された日付、サイトのタイムゾーンでの表示。
date_gmt 投稿が公開された日付、GMT 表示。
slug 投稿のタイプに固有の英数字識別子。
status 投稿の名前付きステータス。
一つの: publish, future, draft, pending, private
password コンテンツと抜粋へのアクセスを保護するためのパスワード。
title 投稿のタイトル。
content 投稿の内容。
meta メタフィールド。
template 投稿を表示するために使用するテーマファイル。

定義

POST /wp/v2/blocks/<id>

例リクエスト

エディターブロックを削除

引数
id 投稿の一意な識別子。
force ゴミ箱をバイパスして強制的に削除するかどうか。

定義

DELETE /wp/v2/blocks/<id>

例リクエスト

$ curl -X DELETE https://example.com/wp-json/wp/v2/blocks/<id>