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) |
|
http_envelope | (bool) |
|
pretty | (bool) |
|
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) |
|
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) |
|
parent | (object|false) | A reference to the comment's parent, if it has one. |
type | (string) |
|
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. |
Resource Errors
These are the possible errors returned by this endpoint.
HTTP Code | Error Identifier | Error Message |
---|---|---|
403 | unauthorized | User cannot view post |
403 | unauthorized | User cannot access this private blog. |
403 | unauthorized | User cannot access this restricted blog |
403 | unauthorized | User cannot delete comment |
403 | trash_disabled | Cannot trash comment |
403 | authorization_required | An active access token must be used to comment. |
403 | unauthorized | Comments on this post are closed |
403 | unauthorized | Comments on drafts are not allowed |
403 | unauthorized | User cannot create comments |
403 | unauthorized | User cannot read unapproved comment |
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 ); ?>
Response
{ "ID": 29, "post": { "ID": 843, "title": "Cats are awesome.", "type": "post", "link": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/posts\/843" }, "author": { "ID": 78972699, "login": "apiexamples", "email": false, "name": "apiexamples", "first_name": "", "last_name": "", "nice_name": "apiexamples", "URL": "http:\/\/apiexamples.wordpress.com", "avatar_URL": "https:\/\/1.gravatar.com\/avatar\/a2afb7b6c0e23e5d363d8612fb1bd5ad?s=96&d=identicon&r=G", "profile_URL": "http:\/\/en.gravatar.com\/apiexamples", "site_ID": 82974409 }, "date": "2015-04-18T20:01:17+00:00", "URL": "https:\/\/apiexamples.wordpress.com\/2015\/04\/18\/cats-are-awesome\/comment-page-1\/#comment-29", "short_URL": "http:\/\/wp.me\/p5C9qV-dB%23comment-29", "content": "<p>This reply is now edited via the API.<\/p>\n", "status": "approved", "parent": false, "type": "comment", "like_count": 0, "i_like": false, "meta": { "links": { "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/comments\/29", "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/comments\/29\/help", "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409", "post": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/posts\/843", "replies": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/comments\/29\/replies\/", "likes": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/comments\/29\/likes\/" } } }