Schema
The schema defines all the fields that exist for a post object.
date
string, datetime (ISO8601) The date the object was published, in the site’s timezone.
Context: view, edit, embed
date_gmt
string, datetime (ISO8601) The date the object was published, as GMT.
Context: view, edit
guid
object The globally unique identifier for the object.
Read only
Context: view, edit
id
integer Unique identifier for the object.
Read only
Context: view, edit, embed
link
string, uri URL to the object.
Read only
Context: view, edit, embed
modified
string, datetime (ISO8601) The date the object was last modified, in the site’s timezone.
Read only
Context: view, edit
modified_gmt
string, datetime (ISO8601) The date the object was last modified, as GMT.
Read only
Context: view, edit
slug
string An alphanumeric identifier for the object unique to its type.
Context: view, edit, embed
status
string A named status for the object.
Context: edit
One of: publish, future, draft, pending, private
type
string Type of Post for the object.
Read only
Context: view, edit, embed
password
string A password to protect access to the content and excerpt.
Context: edit
title
object The title for the object.
Context: view, edit, embed
content
object The content for the object.
Context: view, edit
author
integer The ID for the author of the object.
Context: view, edit, embed
excerpt
object The excerpt for the object.
Context: view, edit, embed
featured_media
integer The ID of the featured media for the object.
Context: view, edit
comment_status
string Whether or not comments are open on the object.
Context: view, edit
One of: open, closed
ping_status
string Whether or not the object can be pinged.
Context: view, edit
One of: open, closed
format
string The format for the object.
Context: view, edit
One of: standard
meta
object Meta fields.
Context: view, edit
sticky
boolean Whether or not the object should be treated as sticky.
Context: view, edit
template
string The theme file to use to display the object.
Context: view, edit
One of:
categories
array The terms assigned to the object in the category taxonomy.
Context: view, edit
tags
array The terms assigned to the object in the post_tag taxonomy.
Context: view, edit
liveblog_likes
integer The number of Liveblog Likes the post has.
Context: view, edit, embed
Example Request
$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/posts
Top ↑
List Posts #List Posts
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 posts published after a given ISO8601 compliant date.
author Limit result set to posts assigned to specific authors.
Default:
author_exclude Ensure result set excludes posts assigned to specific authors.
Default:
before Limit response to posts published before a given ISO8601 compliant date.
exclude Ensure result set excludes specific IDs.
Default:
include Limit result set to specific IDs.
Default:
offset Offset the result set by a specific number of items.
order Order sort attribute ascending or descending.
Default: desc
One of: asc, desc
orderby Sort collection by object attribute.
Default: date
One of: date, relevance, id, include, title, slug
slug Limit result set to posts with one or more specific slugs.
status Limit result set to posts assigned one or more statuses.
Default: publish
categories Limit result set to all items that have the specified term assigned in the categories taxonomy.
Default:
categories_exclude Limit result set to all items except those that have the specified term assigned in the categories taxonomy.
Default:
tags Limit result set to all items that have the specified term assigned in the tags taxonomy.
Default:
tags_exclude Limit result set to all items except those that have the specified term assigned in the tags taxonomy.
Default:
sticky Limit result set to items that are sticky.
Definition
GET /wp/v2/posts
Example Request
$ curl http://demo.wp-api.org/wp-json/wp/v2/posts
Retrieve a Post
Arguments
context Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
password The password for the post if it is password protected.
Definition #Definition
GET /wp/v2/posts/
Example Request #Example Request
$ curl http://demo.wp-api.org/wp-json/wp/v2/posts/
Create a Post #Create a Post
Arguments #Arguments
date The date the object was published, in the site’s timezone.
date_gmt The date the object was published, as GMT.
slug An alphanumeric identifier for the object unique to its type.
status A named status for the object.
One of: publish, future, draft, pending, private
password A password to protect access to the content and excerpt.
title The title for the object.
content The content for the object.
author The ID for the author of the object.
excerpt The excerpt for the object.
featured_media The ID of the featured media for the object.
comment_status Whether or not comments are open on the object.
One of: open, closed
ping_status Whether or not the object can be pinged.
One of: open, closed
format The format for the object.
One of: standard
meta Meta fields.
sticky Whether or not the object should be treated as sticky.
template The theme file to use to display the object.
One of:
categories The terms assigned to the object in the category taxonomy.
tags The terms assigned to the object in the post_tag taxonomy.
liveblog_likes The number of Liveblog Likes the post has.
Definition #Definition
POST /wp/v2/posts
Update a Post #Update a Post
Arguments #Arguments
date The date the object was published, in the site’s timezone.
date_gmt The date the object was published, as GMT.
slug An alphanumeric identifier for the object unique to its type.
status A named status for the object.
One of: publish, future, draft, pending, private
password A password to protect access to the content and excerpt.
title The title for the object.
content The content for the object.
author The ID for the author of the object.
excerpt The excerpt for the object.
featured_media The ID of the featured media for the object.
comment_status Whether or not comments are open on the object.
One of: open, closed
ping_status Whether or not the object can be pinged.
One of: open, closed
format The format for the object.
One of: standard
meta Meta fields.
sticky Whether or not the object should be treated as sticky.
template The theme file to use to display the object.
One of:
categories The terms assigned to the object in the category taxonomy.
tags The terms assigned to the object in the post_tag taxonomy.
liveblog_likes The number of Liveblog Likes the post has.
Definition
POST /wp/v2/posts/<id>
##示例请求
$ curl -X POST http://demo.wp-api.org/wp-json -d '{"title":"My New Title"}'
#Delete a Post
Arguments
force Whether to bypass trash and force deletion.
Definition
DELETE /wp/v2/posts/
Example Request
$ curl -X DELETE http://demo.wp-api.org/wp-json/wp/v2/posts/<id>
