架构
架构定义了页面记录中存在的所有字段。除非使用了 `_filter` 查询参数,或者该架构字段仅出现在特定上下文中,否则预期来自这些端点的响应将包含以下字段。
date | 帖子发布的日期,采用网站时区。 JSON 数据类型:字符串或 null 上下文: |
date_gmt | 帖子发布的日期,采用 GMT。 JSON 数据类型:字符串或 null 上下文: |
guid | 帖子的全局唯一标识符。 JSON 数据类型:对象 只读 上下文: |
id | 帖子的唯一标识符。 JSON 数据类型:整数 只读 上下文: |
link | 帖子的 URL。 JSON 数据类型:字符串 只读 上下文: |
modified | 帖子最后修改的日期,采用网站时区。 JSON 数据类型:字符串 只读 上下文: |
modified_gmt | 帖子最后修改的日期,采用 GMT。 JSON 数据类型:字符串 只读 上下文: |
slug | 帖子类型的字母数字标识符。 JSON 数据类型:字符串 上下文: |
status | 帖子的命名状态。 JSON 数据类型:字符串 上下文: 其中之一: |
type | 帖子类型。 JSON 数据类型:字符串 只读 上下文: |
password | 用于保护内容和摘要访问的密码。 JSON 数据类型:字符串 上下文: |
permalink_template | 帖子的固定链接模板。 JSON 数据类型:字符串 只读 上下文: |
generated_slug | 根据帖子标题自动生成的 Slug。 JSON 数据类型:字符串 只读 上下文: |
parent | 帖子父级的 ID。 JSON 数据类型:整数 上下文: |
title | 帖子的标题。 JSON 数据类型:对象 上下文: |
content | 帖子的内容。 JSON 数据类型:对象 上下文: |
author | 帖子作者的 ID。 JSON 数据类型:整数 上下文: |
excerpt | 帖子的摘要。 JSON 数据类型:对象 上下文: |
featured_media | 帖子特色媒体的 ID。 JSON 数据类型:整数 上下文: |
comment_status | 帖子是否允许评论。 JSON 数据类型:字符串 上下文: 其中之一: |
ping_status | 帖子是否可以被 Ping。 JSON 数据类型:字符串 上下文: 其中之一: |
menu_order | 帖子相对于其他帖子的排序顺序。 JSON 数据类型:整数 上下文: |
meta | 元数据字段。 JSON 数据类型:对象 上下文: |
template | 用于显示帖子的主题文件。 JSON 数据类型:字符串 上下文: |
列出页面
查询此端点以检索页面集合。您收到的响应可以使用下面的 URL 查询参数进行控制和过滤。
定义
GET /wp/v2/pages
示例请求
$ curl https://example.com/wp-json/wp/v2/pages
参数
context | 请求的范围;确定响应中存在的字段。 默认值: 其中之一: |
page | 集合的当前页码。 默认值: |
per_page | 结果集中返回的最大项目数。 默认值: |
search | 将结果限制为与指定字符串匹配的内容。 |
after | 将响应限制为在指定的 ISO8601 合规日期之后发布的帖子。 |
modified_after | 将响应限制为在指定的 ISO8601 合规日期之后修改的帖子。 |
author | 将结果集限制为分配给特定作者的文章。 |
author_exclude | 确保结果集排除分配给特定作者的文章。 |
before | 将响应限制为在指定的 ISO8601 合规日期之前发布的帖子。 |
modified_before | 将响应限制为在指定的 ISO8601 合规日期之前修改的帖子。 |
exclude | 确保结果集排除特定的 ID。 |
include | 将结果集限制为特定的 ID。 |
menu_order | 将结果集限制为具有特定 menu_order 值的帖子。 |
offset | 偏移结果集,跳过特定数量的项目。 |
order | 排序属性是升序还是降序。 默认值: 其中之一: |
orderby | 按帖子属性对集合进行排序。 默认值: 其中之一: |
parent | 将结果集限制为具有特定父级 ID 的项目。 |
parent_exclude | 将结果集限制为除特定父级 ID 之外的所有项目。 |
search_columns | 要搜索的列名数组。 |
slug | 将结果集限制为具有一个或多个特定 slug 的帖子。 |
status | 将结果集限制为分配了一个或多个状态的帖子。 默认值: |
创建页面
参数
date | 文章发布的日期,使用网站时区。 |
date_gmt | 文章发布的日期,以 GMT 时间显示。 |
slug | 文章的字母数字标识符,对该类型唯一。 |
status | 文章的命名状态。 可选值: publish, future, draft, pending, private |
password | 用于保护访问内容和摘要的密码。 |
parent | 文章父级的 ID。 |
title | 文章的标题。 |
content | 文章的内容。 |
author | 文章作者的 ID。 |
excerpt | 文章的摘要。 |
featured_media | 文章特色媒体的 ID。 |
comment_status | 是否允许在文章上评论。 可选值: open, closed |
ping_status | 是否可以对文章进行 Ping。 可选值: open, closed |
menu_order | 文章相对于其他文章的排序顺序。 |
meta | 元字段。 |
template | 用于显示文章的模板文件。 |
定义
POST /wp/v2/pages
检索页面
定义 & 示例请求
GET /wp/v2/pages/<id>
查询此端点以检索特定页面记录。
$ curl https://example.com/wp-json/wp/v2/pages/<id>
参数
id | 文章的唯一标识符。 |
context | 请求的范围;决定响应中存在的字段。 默认值: 可选值: |
password | 如果文章受密码保护,则提供该密码。 |
更新页面
参数
id | 文章的唯一标识符。 |
date | 文章发布的日期,使用网站时区。 |
date_gmt | 文章发布的日期,以 GMT 时间显示。 |
slug | 文章的字母数字标识符,对该类型唯一。 |
status | 文章的命名状态。 可选值: publish, future, draft, pending, private |
password | 用于保护访问内容和摘要的密码。 |
parent | 文章父级的 ID。 |
title | 文章的标题。 |
content | 文章的内容。 |
author | 文章作者的 ID。 |
excerpt | 文章的摘要。 |
featured_media | 文章特色媒体的 ID。 |
comment_status | 是否允许在文章上评论。 可选值: open, closed |
ping_status | 是否可以对文章进行 Ping。 可选值: open, closed |
menu_order | 文章相对于其他文章的排序顺序。 |
meta | 元字段。 |
template | 用于显示文章的模板文件。 |
定义
POST /wp/v2/pages/<id>
示例请求
无
删除页面
参数
id | 文章的唯一标识符。 |
force | 是否绕过回收站并强制删除。 |
定义
DELETE /wp/v2/pages/<id>
示例请求
$ curl -X DELETE https://example.com/wp-json/wp/v2/pages/<id>