wordpress REST API 手册 —- 页面(Pages)
TOPICS
Schema Schema
The schema defines all the fields that exist for a page object.
| date
string, |
The date the object was published, in the site’s timezone.Context: view, edit, embed |
| date_gmt
string, |
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, |
URL to the object.Read only
Context: view, edit, embed |
| modified
string, |
The date the object was last modified, in the site’s timezone.Read only
Context: view, edit |
| modified_gmt
string, |
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: view, 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 |
| permalink_template
string |
Permalink template for the object.Read only
Context: edit |
| generated_slug
string |
Slug automatically generated from the object title.Read only
Context: edit |
| parent
integer |
The ID for the parent of the object.Context: view, 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, embed |
| 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 |
| menu_order
integer |
The order of the object in relation to other object of its type.Context: view, edit |
| meta
object |
Meta fields.Context: view, edit |
| template
string |
The theme file to use to display the object.Context: view, edit |
Example Request Example Request
$ curl -X OPTIONS -i https://example.com/wp-json/wp/v2/pages
List Pages List Pages
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. |
| 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. |
| menu_order | Limit result set to posts with a specific menu_order value. |
| 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: author, date, id, include, modified, parent, relevance, slug, include_slugs, title, menu_order |
| parent | Limit result set to items with particular parent IDs. |
| parent_exclude | Limit result set to all items except those of a particular parent ID. |
| 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 |
Definition Definition
GET /wp/v2/pages
Example Request Example Request
$ curl https://example.com/wp-json/wp/v2/pages
Create a Page Create a Page
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. |
| parent | The ID for the parent of the object. |
| 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 |
| menu_order | The order of the object in relation to other object of its type. |
| meta | Meta fields. |
| template | The theme file to use to display the object. |
Definition Definition
POST /wp/v2/pages
Retrieve a Page Retrieve a Page
Arguments Arguments
| id | Unique identifier for the object. |
| 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/pages/<id>
Example Request Example Request
$ curl https://example.com/wp-json/wp/v2/pages/<id>
Update a Page Update a Page
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. |
| parent | The ID for the parent of the object. |
| 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 |
| menu_order | The order of the object in relation to other object of its type. |
| meta | Meta fields. |
| template | The theme file to use to display the object. |
Definition Definition
POST /wp/v2/pages/<id>
Example Request Example Request
Delete a Page Delete a Page
Arguments Arguments
| id | Unique identifier for the object. |
| force | Whether to bypass trash and force deletion. |
Definition Definition
DELETE /wp/v2/pages/<id>
Example Request Example Request
$ curl -X DELETE https://example.com/wp-json/wp/v2/pages/<id>