Resource Information
Method | POST |
---|---|
URL | https://public-api.wordpress.com/rest/v1.1/sites/$site/posts/$post_ID/restore |
Requires authentication? | Yes |
Method Parameters
Parameter | Type | Description |
---|---|---|
$site | (int|string) | Site ID or domain |
$post_ID | (int) | The post 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. |
Response Parameters
Parameter | Type | Description |
---|---|---|
ID | (int) | The post ID. |
site_ID | (int) | The site ID. |
author | (object) | The author of the post. |
date | (iso 8601 datetime) | The post's creation time. |
modified | (iso 8601 datetime) | The post's most recent update time. |
title | (html) | context dependent. |
URL | (url) | The full permalink URL to the post. |
short_URL | (url) | The wp.me short URL. |
content | (html) | context dependent. |
excerpt | (html) | context dependent. |
slug | (string) | The name (slug) for the post, used in URLs. |
guid | (string) | The GUID for the post. |
status | (string) |
|
sticky | (bool) | Is the post sticky? |
password | (string) | The plaintext password protecting the post, or, more likely, the empty string if the post is not password protected. |
parent | (object|false) | A reference to the post's parent, if it has one. |
type | (string) | The post's post_type. Post types besides post, page and revision need to be whitelisted using the rest_api_allowed_post_types filter. |
discussion | (object) | Hash of discussion options for the post |
likes_enabled | (bool) | Is the post open to likes? |
sharing_enabled | (bool) | Should sharing buttons show on this post? |
like_count | (int) | The number of likes for this post. |
i_like | (bool) | Does the current user like this post? |
is_reblogged | (bool) | Did the current user reblog this post? |
is_following | (bool) | Is the current user following this blog? |
global_ID | (string) | A unique WordPress.com-wide representation of a post. |
featured_image | (url) | The URL to the featured image for this post if it has one. |
post_thumbnail | (object) | The attachment object for the featured image if it has one. |
format | (string) |
|
geo | (object|false) | |
menu_order | (int) | (Pages Only) The order pages should appear in. |
page_template | (string) | (Pages Only) The page template this page is using. |
publicize_URLs | (array) | Array of Twitter and Facebook URLs published by this post. |
terms | (object) | Hash of taxonomy names mapping to a hash of terms keyed by term name. |
tags | (object) | Hash of tags (keyed by tag name) applied to the post. |
categories | (object) | Hash of categories (keyed by category name) applied to the post. |
attachments | (object) | Hash of post attachments (keyed by attachment ID). Returns the most recent 20 attachments. Use the `/sites/$site/media` endpoint to query the attachments beyond the default of 20 that are returned here. |
attachment_count | (int) | The total number of attachments for this post. Use the `/sites/$site/media` endpoint to query the attachments beyond the default of 20 that are returned here. |
metadata | (array) | Array of post metadata keys and values. All unprotected meta keys are available by default for read requests. Both unprotected and protected meta keys are available for authenticated requests with access. Protected meta keys can be made available with the rest_api_allowed_public_metadata filter. |
meta | (object) | API result meta data |
capabilities | (object) | List of post-specific permissions for the user; publish_post, edit_post, delete_post |
revisions | (array) | List of post revision IDs. Only available for posts retrieved with context=edit. |
other_URLs | (object) | List of URLs for this post. Permalink and slug suggestions. |
Resource Errors
These are the possible errors returned by this endpoint.
HTTP Code | Error Identifier | Error Message |
---|---|---|
403 | unauthorized | SEO tools are not enabled for this site. |
403 | invalid_input | Invalid file type. |
403 | unauthorized | User cannot delete post |
400 | invalid_field | Invalid API FIELD |
403 | unauthorized | User cannot access this private blog. |
403 | unauthorized | User cannot access this restricted blog |
403 | unauthorized | User cannot restore trashed posts |
403 | unauthorized | Assigned author cannot publish post. |
403 | unauthorized | User cannot delete posts |
403 | unauthorized | User cannot edit posts |
Example
curl \ -H 'authorization: Bearer YOUR_API_TOKEN' \ 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/posts/$post_ID/restore/'
<?php $options = array ( 'http' => array ( 'ignore_errors' => true, 'method' => 'POST', 'header' => array ( 0 => 'authorization: Bearer YOUR_API_TOKEN', ), ), ); $context = stream_context_create( $options ); $response = file_get_contents( 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/posts/$post_ID/restore/', false, $context ); $response = json_decode( $response ); ?>
Response
{ "ID": 21549, "site_ID": "82974409", "author": null, "date": "2019-07-12T06:00:22+00:00", "modified": "2019-07-12T06:00:22+00:00", "title": "This is a test post.", "URL": "https:\/\/apiexamples.wordpress.com\/?p=21549", "short_URL": "https:\/\/wp.me\/p5C9qV-5Bz", "content": "<p>This is my post’s content.<\/p>\n", "excerpt": "<p>This is my post’s content.<\/p>\n", "slug": "this-is-a-test-post-4", "guid": "https:\/\/apiexamples.wordpress.com\/?p=21549", "status": "draft", "sticky": false, "password": "", "parent": false, "type": "post", "discussion": { "comments_open": true, "comment_status": "open", "pings_open": true, "ping_status": "open", "comment_count": 0 }, "likes_enabled": true, "sharing_enabled": true, "like_count": 0, "i_like": false, "is_reblogged": false, "is_following": true, "global_ID": "4cf7ca42be0538604c874b5c3d5e5eca", "featured_image": "", "post_thumbnail": null, "format": "standard", "geo": false, "menu_order": 0, "page_template": "", "publicize_URLs": [], "terms": { "category": { "Uncategorized": { "ID": 1, "name": "Uncategorized", "slug": "uncategorized", "description": "", "post_count": 6, "parent": 0, "meta": { "links": { "self": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/categories\/slug:uncategorized", "help": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/categories\/slug:uncategorized\/help", "site": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409" } } } }, "post_tag": {}, "post_format": {}, "mentions": {} }, "tags": {}, "categories": { "Uncategorized": { "ID": 1, "name": "Uncategorized", "slug": "uncategorized", "description": "", "post_count": 6, "parent": 0, "meta": { "links": { "self": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/categories\/slug:uncategorized", "help": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/categories\/slug:uncategorized\/help", "site": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409" } } } }, "attachments": {}, "attachment_count": 0, "metadata": false, "meta": { "links": { "self": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/posts\/21549", "help": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/posts\/21549\/help", "site": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409", "replies": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/posts\/21549\/replies\/", "likes": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/posts\/21549\/likes\/" } }, "capabilities": { "publish_post": true, "delete_post": true, "edit_post": true }, "other_URLs": { "permalink_URL": "https:\/\/apiexamples.wordpress.com\/2019\/07\/12\/%postname%\/", "suggested_slug": "this-is-a-test-post-4" } }