スキーマ

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

id コメントのユニーク識別子。
JSONデータ型: 整数
読み取り専用
コンテキスト: view, edit, embed
author 著者がユーザーであった場合のユーザーオブジェクトのID。
JSONデータ型: 整数
コンテキスト: view, edit, embed
author_email コメント著者のメールアドレス。
JSONデータ型: 文字列,
フォーマット: email

コンテキスト: edit
author_ip コメント著者のIPアドレス。
JSONデータ型: 文字列,
フォーマット: ip

コンテキスト: edit
author_name コメント著者の表示名。
JSONデータ型: 文字列
コンテキスト: view, edit, embed
author_url コメント著者のURL。
JSONデータ型: 文字列,
フォーマット: uri

コンテキスト: view, edit, embed
author_user_agent コメント著者のユーザーエージェント。
JSONデータ型: 文字列
コンテキスト: edit
content コメントの内容。
JSONデータ型: オブジェクト
コンテキスト: view, edit, embed
date コメントが公開された日付、サイトのタイムゾーンで。
JSONデータ型: 文字列,
フォーマット: datetime ( 詳細)

コンテキスト: view, edit, embed
date_gmt コメントが公開された日付、GMTとして。
JSONデータ型: 文字列,
フォーマット: datetime ( 詳細)

コンテキスト: view, edit
link コメントへのURL。
JSONデータ型: 文字列,
フォーマット: uri

読み取り専用
コンテキスト: view, edit, embed
parent コメントの親のID。
JSONデータ型: 整数
コンテキスト: view, edit, embed
post 関連する投稿オブジェクトのID。
JSONデータ型: 整数
コンテキスト: view, edit
status コメントの状態。
JSONデータ型: 文字列
コンテキスト: view, edit
type コメントのタイプ。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
author_avatar_urls コメント著者のアバターURL。
JSONデータ型: オブジェクト
読み取り専用
コンテキスト: view, edit, embed
meta メタフィールド。
JSONデータ型: オブジェクト
コンテキスト: view, edit

コメントのリスト

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

定義

GET /wp/v2/comments

例リクエスト

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

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

次のいずれか: view, embed, edit
page コレクションの現在のページ。
デフォルト: 1
per_page 結果セットに返される最大アイテム数。
デフォルト: 10
search 文字列に一致する結果に制限します。
after 指定されたISO8601準拠の日付以降に公開されたコメントに制限します。
author 特定のユーザーIDに割り当てられたコメントに結果セットを制限します。認証が必要です。
author_exclude 特定のユーザーIDに割り当てられたコメントを結果セットから除外します。認証が必要です。
author_email 特定の著者のメールからの結果セットに制限します。認証が必要です。
before 指定されたISO8601準拠の日付以前に公開されたコメントに制限します。
exclude 特定のIDを除外するように結果セットを確保します。
include 特定のIDに制限します。
offset 特定のアイテム数だけ結果セットをオフセットします。
order ソート属性を昇順または降順にします。
デフォルト: desc

次のいずれか: asc, desc
orderby コメント属性でコレクションをソートします。
デフォルト: date_gmt

次のいずれか: date, date_gmt, id, include, post, parent, type
parent 特定の親IDのコメントに結果セットを制限します。
parent_exclude 特定の親IDを除外するように結果セットを確保します。
post 特定の投稿IDに割り当てられたコメントに結果セットを制限します。
status 特定の状態に割り当てられたコメントに結果セットを制限します。認証が必要です。
デフォルト: approve
type 特定のタイプに割り当てられたコメントに結果セットを制限します。認証が必要です。
デフォルト: comment
password 投稿がパスワード保護されている場合のパスワード。

コメントを作成

引数
author 著者がユーザーであった場合のユーザーオブジェクトのID。
author_email コメント著者のメールアドレス。
author_ip コメント著者のIPアドレス。
author_name コメント著者の表示名。
author_url コメント著者のURL。
author_user_agent コメント著者のユーザーエージェント。
content コメントの内容。
date コメントが公開された日付、サイトのタイムゾーンで。
date_gmt コメントが公開された日付、GMTとして。
parent コメントの親のID。
post 関連する投稿オブジェクトのID。
status コメントの状態。
meta メタフィールド。

定義

POST /wp/v2/comments

コメントを取得

定義と例リクエスト

GET /wp/v2/comments/<id>

このエンドポイントをクエリして、特定のコメントレコードを取得します。

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

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

次のいずれか: view, embed, edit
password コメントの親投稿のパスワード（投稿がパスワード保護されている場合）。

コメントを更新

引数
id コメントのユニーク識別子。
author 著者がユーザーであった場合のユーザーオブジェクトのID。
author_email コメント著者のメールアドレス。
author_ip コメント著者のIPアドレス。
author_name コメント著者の表示名。
author_url コメント著者のURL。
author_user_agent コメント著者のユーザーエージェント。
content コメントの内容。
date コメントが公開された日付、サイトのタイムゾーンで。
date_gmt コメントが公開された日付、GMTとして。
parent コメントの親のID。
post 関連する投稿オブジェクトのID。
status コメントの状態。
meta メタフィールド。

定義

POST /wp/v2/comments/<id>

例リクエスト

コメントを削除

引数
id コメントのユニーク識別子。
force ゴミ箱をバイパスして強制的に削除するかどうか。
password コメントの親投稿のパスワード（投稿がパスワード保護されている場合）。

定義

DELETE /wp/v2/comments/<id>

例リクエスト

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