スキーマ
スキーマは、投稿レコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_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 |
permalink_template |
投稿のパーマリンクテンプレート。 JSONデータ型: 文字列 読み取り専用 コンテキスト: edit |
generated_slug |
投稿タイトルから自動生成されたスラッグ。 JSONデータ型: 文字列 読み取り専用 コンテキスト: edit |
title |
投稿のタイトル。 JSONデータ型: オブジェクト コンテキスト: view , edit , embed |
content |
投稿のコンテンツ。 JSONデータ型: オブジェクト コンテキスト: view , edit |
author |
投稿の著者のID。 JSONデータ型: 整数 コンテキスト: view , edit , embed |
excerpt |
投稿の抜粋。 JSONデータ型: オブジェクト コンテキスト: view , edit , embed |
featured_media |
投稿のフィーチャードメディアのID。 JSONデータ型: 整数 コンテキスト: view , edit , embed |
comment_status |
投稿にコメントがオープンかどうか。 JSONデータ型: 文字列 コンテキスト: view , edit 一つの: open , closed |
ping_status |
投稿がピング可能かどうか。 JSONデータ型: 文字列 コンテキスト: view , edit 一つの: open , closed |
format |
投稿のフォーマット。 JSONデータ型: 文字列 コンテキスト: view , edit 一つの: standard , aside , chat , gallery , link , image , quote , status , video , audio |
meta |
メタフィールド。 JSONデータ型: オブジェクト コンテキスト: view , edit |
sticky |
投稿がスティッキーとして扱われるべきかどうか。 JSONデータ型: ブール値 コンテキスト: view , edit |
template |
投稿を表示するために使用するテーマファイル。 JSONデータ型: 文字列 コンテキスト: view , edit |
categories |
カテゴリタクソノミーで投稿に割り当てられた用語。 JSONデータ型: 配列 コンテキスト: view , edit |
tags |
投稿に割り当てられた投稿_タグタクソノミーの用語。 JSONデータ型: 配列 コンテキスト: view , edit |
投稿のリスト
このエンドポイントをクエリして、投稿のコレクションを取得します。受け取る応答は、以下のURLクエリパラメータを使用して制御およびフィルタリングできます。
定義
例リクエスト
$ curl https://example.com/wp-json/wp/v2/posts
引数
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view 一つの: view , embed , edit |
page |
コレクションの現在のページ。 デフォルト: 1 |
per_page |
結果セットに返される最大アイテム数。 デフォルト: 10 |
search |
文字列に一致する結果に制限します。 |
after |
指定されたISO8601準拠の日付以降に公開された投稿に制限します。 |
modified_after |
指定されたISO8601準拠の日付以降に修正された投稿に制限します。 |
author |
特定の著者に割り当てられた投稿に制限します。 |
author_exclude |
特定の著者に割り当てられた投稿を除外することを確認します。 |
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 |
tax_relation |
複数のタクソノミー間の関係に基づいて結果セットを制限します。 一つの: AND , OR |
categories |
カテゴリタクソノミーで特定の用語が割り当てられたアイテムに制限します。 |
categories_exclude |
カテゴリタクソノミーで特定の用語が割り当てられたアイテムを除外します。 |
tags |
タグタクソノミーで特定の用語が割り当てられたアイテムに制限します。 |
tags_exclude |
タグタクソノミーで特定の用語が割り当てられたアイテムを除外します。 |
sticky |
スティッキーなアイテムに制限します。 |
投稿を作成
引数
date |
投稿が公開された日付、サイトのタイムゾーンでの表示。 |
date_gmt |
投稿が公開された日付、GMTでの表示。 |
slug |
投稿のタイプに固有の英数字識別子。 |
status |
投稿の名前付きステータス。 一つの: publish , future , draft , pending , private |
password |
コンテンツと抜粋へのアクセスを保護するためのパスワード。 |
title |
投稿のタイトル。 |
content |
投稿のコンテンツ。 |
author |
投稿の著者のID。 |
excerpt |
投稿の抜粋。 |
featured_media |
投稿のフィーチャードメディアのID。 |
comment_status |
投稿にコメントがオープンかどうか。 一つの: open , closed |
ping_status |
投稿がピング可能かどうか。 一つの: open , closed |
format |
投稿のフォーマット。 一つの: standard , aside , chat , gallery , link , image , quote , status , video , audio |
meta |
メタフィールド。 |
sticky |
投稿がスティッキーとして扱われるべきかどうか。 |
template |
投稿を表示するために使用するテーマファイル。 |
categories |
カテゴリタクソノミーで投稿に割り当てられた用語。 |
tags |
投稿に割り当てられた投稿_タグタクソノミーの用語。 |
定義
POST /wp/v2/posts
投稿を取得
定義と例リクエスト
GET /wp/v2/posts/<id>
このエンドポイントをクエリして特定の投稿レコードを取得します。
$ curl https://example.com/wp-json/wp/v2/posts/<id>
引数
id |
投稿の一意な識別子。 |
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view 一つの: view , embed , edit |
password |
投稿がパスワード保護されている場合のパスワード。 |
投稿を更新
引数
id |
投稿の一意な識別子。 |
date |
投稿が公開された日付、サイトのタイムゾーンでの表示。 |
date_gmt |
投稿が公開された日付、GMTでの表示。 |
slug |
投稿のタイプに固有の英数字識別子。 |
status |
投稿の名前付きステータス。 一つの: publish , future , draft , pending , private |
password |
コンテンツと抜粋へのアクセスを保護するためのパスワード。 |
title |
投稿のタイトル。 |
content |
投稿のコンテンツ。 |
author |
投稿の著者のID。 |
excerpt |
投稿の抜粋。 |
featured_media |
投稿のフィーチャードメディアのID。 |
comment_status |
投稿にコメントがオープンかどうか。 一つの: open , closed |
ping_status |
投稿がピング可能かどうか。 一つの: open , closed |
format |
投稿のフォーマット。 一つの: standard , aside , chat , gallery , link , image , quote , status , video , audio |
meta |
メタフィールド。 |
sticky |
投稿がスティッキーとして扱われるべきかどうか。 |
template |
投稿を表示するために使用するテーマファイル。 |
categories |
カテゴリタクソノミーで投稿に割り当てられた用語。 |
tags |
投稿に割り当てられた投稿_タグタクソノミーの用語。 |
定義
例リクエスト
`````$ curl -X POST https://example.com/wp-json/wp/v2/posts/
<a name="delete-a-post"></a>
## 投稿を削除
<a name="arguments-5"></a>
### 引数
| | |
| --- | --- |
| `````id````` | 投稿の一意な識別子。 |
| `````force````` | ゴミ箱をバイパスして強制的に削除するかどうか。 |
<a name="definition-4"></a>
### 定義
`````DELETE /wp/v2/posts/<id>
例リクエスト
$ curl -X DELETE https://example.com/wp-json/wp/v2/posts/<id>