スキーマ

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

id テンプレートの ID。
JSON データ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
slug テンプレートを識別するユニークなスラッグ。
JSON データ型: 文字列
コンテキスト: embed, view, edit
theme テンプレートのテーマ識別子。
JSON データ型: 文字列
コンテキスト: embed, view, edit
type テンプレートのタイプ。
JSON データ型: 文字列
コンテキスト: embed, view, edit
source テンプレートのソース
JSON データ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
origin カスタマイズされたテンプレートのソース
JSON データ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
content テンプレートの内容。
JSON データ型: オブジェクトまたは文字列
コンテキスト: embed, view, edit
title テンプレートのタイトル。
JSON データ型: オブジェクトまたは文字列
コンテキスト: embed, view, edit
description テンプレートの説明。
JSON データ型: 文字列
コンテキスト: embed, view, edit
status テンプレートのステータス。
JSON データ型: 文字列
コンテキスト: embed, view, edit
いずれか: publish, future, draft, pending, private
wp_id 投稿 ID。
JSON データ型: 整数
読み取り専用
コンテキスト: embed, view, edit
has_theme_file テーマファイルが存在するか。
JSON データ型: bool
読み取り専用
コンテキスト: embed, view, edit
author テンプレートの著者の ID。
JSON データ型: 整数
コンテキスト: view, edit, embed
modified テンプレートが最後に変更された日付（サイトのタイムゾーン）。
JSON データ型: 文字列,
フォーマット: datetime ( 詳細)

読み取り専用
コンテキスト: view, edit
area テンプレートパートが使用される場所（ヘッダー、フッターなど）
JSON データ型: 文字列
コンテキスト: embed, view, edit

テンプレートパートを取得する

定義と例リクエスト

GET /wp/v2/template-parts

特定の template_part レコードを取得するためにこのエンドポイントにクエリを送信します。

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

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

いずれか: view, embed, edit
wp_id 指定された投稿 ID に制限します。
area 指定されたテンプレートパートエリアに制限します。
post_type テンプレートを取得するための投稿タイプ。

テンプレートパートを作成する

引数
slug テンプレートを識別するユニークなスラッグ。
必須: 1
theme テンプレートのテーマ識別子。
type テンプレートのタイプ。
content テンプレートの内容。
title テンプレートのタイトル。
description テンプレートの説明。
status テンプレートのステータス。
デフォルト: publish

いずれか: publish, future, draft, pending, private
author テンプレートの著者の ID。
area テンプレートパートが使用される場所（ヘッダー、フッターなど）

定義

POST /wp/v2/template-parts

テンプレートパートを取得する

定義と例リクエスト

GET /wp/v2/template-parts/<id>?)[\/\w%-]+)

特定の template_part レコードを取得するためにこのエンドポイントにクエリを送信します。

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

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

いずれか: view, embed, edit

テンプレートパートを更新する

引数
id テンプレートの ID
slug テンプレートを識別するユニークなスラッグ。
theme テンプレートのテーマ識別子。
type テンプレートのタイプ。
content テンプレートの内容。
title テンプレートのタイトル。
description テンプレートの説明。
status テンプレートのステータス。
いずれか: publish, future, draft, pending, private
author テンプレートの著者の ID。
area テンプレートパートが使用される場所（ヘッダー、フッターなど）

定義

POST /wp/v2/template-parts/<id>?)[\/\w%-]+)

例リクエスト

テンプレートパートを削除する

引数
id テンプレートの ID
force ゴミ箱をバイパスして強制的に削除するかどうか。

定義

DELETE /wp/v2/template-parts/<id>?)[\/\w%-]+)

例リクエスト

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