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