WP REST API v2 Documentation

スキーマ

スキーマはcommentオブジェクトに存在するすべてのフィールドを定義しています。

`id` integer	Unique identifier for the object. 読み取り専用コンテキスト: `view`, `edit`, `embed`
`author` integer	The ID of the user object, if author was a user. コンテキスト: `view`, `edit`, `embed`
`author_email` string, email	Email address for the object author. コンテキスト: `edit`
`author_ip` string, ip	IP address for the object author. コンテキスト: `edit`
`author_name` string	Display name for the object author. コンテキスト: `view`, `edit`, `embed`
`author_url` string, uri	URL for the object author. コンテキスト: `view`, `edit`, `embed`
`author_user_agent` string	User agent for the object author. コンテキスト: `edit`
`content` object	The content for the object. コンテキスト: `view`, `edit`, `embed`
`date` string, datetime (ISO8601)	The date the object was published, in the site's timezone. コンテキスト: `view`, `edit`, `embed`
`date_gmt` string, datetime (ISO8601)	The date the object was published, as GMT. コンテキスト: `view`, `edit`
`link` string, uri	URL to the object. 読み取り専用コンテキスト: `view`, `edit`, `embed`
`parent` integer	The ID for the parent of the object. コンテキスト: `view`, `edit`, `embed`
`post` integer	The ID of the associated post object. コンテキスト: `view`, `edit`
`status` string	State of the object. コンテキスト: `view`, `edit`
`type` string	Type of Comment for the object. 読み取り専用コンテキスト: `view`, `edit`, `embed`
`author_avatar_urls` object	Avatar URLs for the object author. 読み取り専用コンテキスト: `view`, `edit`, `embed`
`meta` object	Meta fields. コンテキスト: `view`, `edit`

Example Request

$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/comments

Comment一覧

引数

`context`	Scope under which the request is made; determines fields present in response. 初期値: `view` 次のいずれか: `view`, `embed`, `edit`
`page`	Current page of the collection. 初期値: `1`
`per_page`	Maximum number of items to be returned in result set. 初期値: `10`
`search`	Limit results to those matching a string.
`after`	Limit response to comments published after a given ISO8601 compliant date.
`author`	Limit result set to comments assigned to specific user IDs. Requires authorization.
`author_exclude`	Ensure result set excludes comments assigned to specific user IDs. Requires authorization.
`author_email`	Limit result set to that from a specific author email. Requires authorization.
`before`	Limit response to comments published before a given ISO8601 compliant date.
`exclude`	Ensure result set excludes specific IDs. 初期値:
`include`	Limit result set to specific IDs. 初期値:
`offset`	Offset the result set by a specific number of items.
`order`	Order sort attribute ascending or descending. 初期値: `desc` 次のいずれか: `asc`, `desc`
`orderby`	Sort collection by object attribute. 初期値: `date_gmt` 次のいずれか: `date`, `date_gmt`, `id`, `include`, `post`, `parent`, `type`
`parent`	Limit result set to comments of specific parent IDs. 初期値:
`parent_exclude`	Ensure result set excludes specific parent IDs. 初期値:
`post`	Limit result set to comments assigned to specific post IDs. 初期値:
`status`	Limit result set to comments assigned a specific status. Requires authorization. 初期値: `approve`
`type`	Limit result set to comments assigned a specific type. Requires authorization. 初期値: `comment`
`password`	The password for the post if it is password protected.

定義

GET /wp/v2/comments

リクエスト例

$ curl http://demo.wp-api.org/wp-json/wp/v2/comments

Commentを取得する

引数

id

Unique identifier for the object.

context

Scope under which the request is made; determines fields present in response.

初期値: view

次のいずれか: view, embed, edit

password

The password for the parent post of the comment (if the post is password protected).

定義

GET /wp/v2/comments/<id>

リクエスト例

$ curl http://demo.wp-api.org/wp-json/wp/v2/comments/<id>

Commentを作成

引数

`author`	The ID of the user object, if author was a user.
`author_email`	Email address for the object author.
`author_ip`	IP address for the object author.
`author_name`	Display name for the object author.
`author_url`	URL for the object author.
`author_user_agent`	User agent for the object author.
`content`	The content for the object.
`date`	The date the object was published, in the site's timezone.
`date_gmt`	The date the object was published, as GMT.
`parent`	The ID for the parent of the object. 初期値: `0`
`post`	The ID of the associated post object. 初期値: `0`
`status`	State of the object.
`meta`	Meta fields.

定義

POST /wp/v2/comments

Commentを更新する

引数

`id`	Unique identifier for the object.
`author`	The ID of the user object, if author was a user.
`author_email`	Email address for the object author.
`author_ip`	IP address for the object author.
`author_name`	Display name for the object author.
`author_url`	URL for the object author.
`author_user_agent`	User agent for the object author.
`content`	The content for the object.
`date`	The date the object was published, in the site's timezone.
`date_gmt`	The date the object was published, as GMT.
`parent`	The ID for the parent of the object.
`post`	The ID of the associated post object.
`status`	State of the object.
`meta`	Meta fields.

定義

POST /wp/v2/comments/<id>

リクエスト例

Commentを削除

引数

`id`	Unique identifier for the object.
`force`	Whether to bypass trash and force deletion.
`password`	The password for the parent post of the comment (if the post is password protected).

定義

DELETE /wp/v2/comments/<id>

リクエスト例

$ curl -X DELETE http://demo.wp-api.org/wp-json/wp/v2/comments/<id>