スキーマ
スキーマは、テンプレートレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_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 |
is_custom |
テンプレートがカスタムテンプレートであるかどうか。 JSONデータ型: bool 読み取り専用 コンテキスト: embed , view , edit |
テンプレートを取得する
定義と例リクエスト
GET /wp/v2/templates
このエンドポイントをクエリして特定のテンプレートレコードを取得します。
$ curl https://example.com/wp-json/wp/v2/templates
引数
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。 |
定義
POST /wp/v2/templates
テンプレートを取得する
定義と例リクエスト
GET /wp/v2/templates/<id>?)[\/\w%-]+)
このエンドポイントをクエリして特定のテンプレートレコードを取得します。
$ curl https://example.com/wp-json/wp/v2/templates/<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。 |
定義
POST /wp/v2/templates/<id>?)[\/\w%-]+)
例リクエスト
テンプレートを削除する
引数
id |
テンプレートのID |
force |
ゴミ箱をバイパスして強制的に削除するかどうか。 |
定義
DELETE /wp/v2/templates/<id>?)[\/\w%-]+)
例リクエスト
$ curl -X DELETE https://example.com/wp-json/wp/v2/templates/<id>?)[\/\w%-]+)