Comments

Topics

Schema Schema

The schema defines all the fields that exist for a comment object.

id

integer
 Unique identifier for the object.

Read only

Context: view, edit, embed
author

integer
 The id of the user object, if author was a user.

Context: view, edit, embed
author_email

string,
email 		 Email address for the object author.

Context: edit
author_ip

string,
ipv4 		 IP address for the object author.

Context: edit
author_name

string
 Display name for the object author.

Context: view, edit, embed
author_url

string,
uri 		 URL for the object author.

Context: view, edit, embed
author_user_agent

string
 User agent for the object author.

Read only

Context: edit
content

object
 The content for the object.

Context: view, edit, embed
date

string,
datetime (details) 		 The date the object was published.

Context: view, edit, embed
date_gmt

string,
datetime (details)

 

 The date the object was published as GMT.

Context: view, edit
karma

integer
 Karma for the object.

Context: edit
parent

integer
 The id for the parent of the object.

Context: view, edit, embed
post

integer
 The id of the associated post object.

Context: view, edit
status

string
 State of the object.

Context: view, edit
type

string
 Type of Comment for the object.

Context: view, edit, embed
author_avatar_urls

object
 Avatar URLs for the object author.

Read only

Context: view, edit, embed
meta

object
 Meta fields.

Context: view, edit

Example Request Example Request

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

Top ↑

List Comments List Comments

Top ↑

Arguments Arguments

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

Default: view

One of: view, embed, edit
page Current page of the collection.

Default: 1
per_page Maximum number of items to be returned in result set.

Default: 10
search Limit results to those matching a string.
after Limit response to resources published after a given date (details).
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 resources published before a given date (details).
exclude Ensure result set excludes specific ids.

Default:

include Limit result set to specific ids.

Default:

karma Limit result set to that of a particular comment karma. Requires authorization.
offset Offset the result set by a specific number of comments.
order Order sort attribute ascending or descending.

Default: desc

One of: asc, desc
orderby Sort collection by object attribute.

Default: date_gmt

One of: date, date_gmt, id, include, post, parent, type
parent Limit result set to resources of specific parent ids.

Default:

parent_exclude Ensure result set excludes specific parent ids.

Default:

post Limit result set to resources assigned to specific post ids.

Default:

status Limit result set to comments assigned a specific status. Requires authorization.

Default: approve
type Limit result set to comments assigned a specific type. Requires authorization.

Default: comment

Top ↑

Definition Definition

GET /wp/v2/comments

Example Request Example Request

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

Top ↑

Retrieve a Comment Retrieve a Comment

Top ↑

Arguments Arguments

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

Default: view

One of: view, embed, edit

Top ↑

Definition Definition

GET /wp/v2/comments/<id>

Example Request Example Request

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

Top ↑

Create a Comment Create a Comment

Top ↑

Arguments Arguments

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.

Default: 127.0.0.1
author_name Display name for the object author.
author_url URL for the object author.
content The content for the object.
date The date the object was published.
date_gmt The date the object was published as GMT.
karma Karma for the object.
parent The id for the parent of the object.

Default: 0
post The id of the associated post object.

Default: 0
status State of the object.
type Type of Comment for the object.

Default: comment
meta Meta fields.

Top ↑

Definition Definition

POST /wp/v2/comments

Top ↑

Update a Comment Update a Comment

Top ↑

Arguments Arguments

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.
content The content for the object.
date The date the object was published.
date_gmt The date the object was published as GMT.
karma Karma for the object.
parent The id for the parent of the object.
post The id of the associated post object.
status State of the object.
type Type of Comment for the object.
meta Meta fields.

Top ↑

Definition Definition

POST /wp/v2/comments/<id>

Example Request Example Request

Top ↑

Delete a Comment Delete a Comment

Top ↑

Arguments Arguments

force Whether to bypass trash and force deletion.

Top ↑

Definition Definition

DELETE /wp/v2/comments/<id>

Example Request Example Request

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