Skip to content

POST /sites/$site/comments/$comment_ID

Edit a comment.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/comments/$comment_ID
Requires authentication? Yes

Method Parameters

Parameter Type Description
$site (int|string) Site ID or domain
$comment_ID (int) The comment ID

Query Parameters

Parameter Type Description
context (string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
false:
(default)
true:
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.

Request Parameters

Parameter Type Description
author (string) The comment author's name.
author_email (string) The comment author's email.
author_url (string) The comment author's URL.
content (html) The comment text.
date (iso 8601 datetime) The comment's creation time.
status (string)
approved:
(default) Approve the comment.
unapproved:
Remove the comment from public view and send it to the moderation queue.
spam:
Mark the comment as spam.
unspam:
Unmark the comment as spam. Will attempt to set it to the previous status.
trash:
Send a comment to the trash if trashing is enabled (see constant: EMPTY_TRASH_DAYS).
untrash:
Untrash a comment. Only works when the comment is in the trash.

Response Parameters

Parameter Type Description
ID (int) The comment ID.
post (object) A reference to the comment's post.
author (object) The author of the comment.
date (iso 8601 datetime) The comment's creation time.
URL (url) The full permalink URL to the comment.
short_URL (url) The wp.me short URL.
content (html) context dependent.
raw_content (string) Raw comment content.
status (string)
approved:
The comment has been approved.
unapproved:
The comment has been held for review in the moderation queue.
spam:
The comment has been marked as spam.
trash:
The comment is in the trash.
parent (object|false) A reference to the comment's parent, if it has one.
type (string)
comment:
The comment is a regular comment.
trackback:
The comment is a trackback.
pingback:
The comment is a pingback.
review:
The comment is a product review.
like_count (int) The number of likes for this comment.
i_like (bool) Does the current user like this comment?
meta (object) Meta data
can_moderate (bool) Whether current user can moderate the comment.
i_replied (bool) Has the current user replied to this comment?

Resource Errors

This endpoint does not return any errors.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 --data-urlencode 'content=This reply is now edited via the API.' \
 --data-urlencode 'status=approved' \
 'https://public-api.wordpress.com/rest/v1/sites/82974409/comments/29'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
      1 => 'Content-Type: application/x-www-form-urlencoded',
    ),
    'content' => 
     http_build_query(  array (
        'content' => 'This reply is now edited via the API.',
        'status' => 'approved',
      )),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/sites/82974409/comments/29',
	false,
	$context
);
$response = json_decode( $response );
?>