架构
架构定义了帖子记录中存在的所有字段。除非使用了 `_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 | 从帖子标题自动生成的别名。 JSON 数据类型：字符串 只读 上下文： |
title | 帖子标题。 JSON 数据类型：对象 上下文： |
content | 帖子内容。 JSON 数据类型：对象 上下文： |
author | 帖子作者的 ID。 JSON 数据类型：整数 上下文： |
excerpt | 帖子摘要。 JSON 数据类型：对象 上下文： |
featured_media | 帖子特色媒体的 ID。 JSON 数据类型：整数 上下文： |
comment_status | 帖子是否允许评论。 JSON 数据类型：字符串 上下文： 其中之一： |
ping_status | 帖子是否可以被 ping。 JSON 数据类型：字符串 上下文： 其中之一： |
format | 帖子格式。 JSON 数据类型：字符串 上下文： 其中之一： |
meta | 元数据字段。 JSON 数据类型：对象 上下文： |
sticky | 帖子是否应被视为置顶。 JSON 数据类型：布尔值 上下文： |
template | 用于显示帖子的主题文件。 JSON 数据类型：字符串 上下文： |
categories | 分配给帖子分类法中的术语。 JSON 数据类型：数组 上下文： |
tags | 分配给帖子 post_tag 分类法中的术语。 JSON 数据类型：数组 上下文： |
列出帖子
查询此端点以检索帖子集合。您可以使用以下 URL 查询参数来控制和过滤收到的响应。
定义
GET /wp/v2/posts
示例请求
$ curl https://example.com/wp-json/wp/v2/posts
参数
context | 执行请求的范围；决定响应中存在的字段。 默认值： 其中之一： |
page | 集合的当前页码。 默认值： |
per_page | 结果集中返回的最大项目数。 默认值： |
search | 将结果限制为匹配某个字符串的项。 |
after | 将响应限制为在给定 ISO8601 合规日期之后发布的帖子。 |
modified_after | 将响应限制为在给定 ISO8601 合规日期之后修改的帖子。 |
author | 将结果集限制为分配给特定作者的帖子。 |
author_exclude | 确保结果集排除分配给特定作者的帖子。 |
before | 将响应限制为在给定 ISO8601 合规日期之前发布的帖子。 |
modified_before | 将响应限制为在给定 ISO8601 合规日期之前修改的帖子。 |
exclude | 确保结果集排除特定的 ID。 |
include | 将结果集限制为特定的 ID。 |
offset | 偏移结果集指定的项目数量。 |
order | 排序属性升序或降序。 默认值： 其中之一： |
orderby | 按帖子属性对集合进行排序。 默认值： 其中之一： |
search_columns | 要搜索的列名数组。 |
slug | 将结果集限制为具有一个或多个特定别名的帖子。 |
status | 将结果集限制为分配了一个或多个状态的帖子。 默认值： |
tax_relation | 基于多个分类法之间的关系限制结果集。 其中之一： AND, OR |
categories | 将结果集限制为在 categories 分类法中分配了特定术语的项目。 |
categories_exclude | 将结果集限制为除了那些在 categories 分类法中分配了特定术语的项目之外的所有项目。 |
tags | 将结果集限制为在 tags 分类法中分配了特定术语的项目。 |
tags_exclude | 将结果集限制为除了那些在 tags 分类法中分配了特定术语的项目之外的所有项目。 |
sticky | 将结果集限制为置顶的项目。 |
创建帖子
参数
date | 文章发布的日期，使用网站时区。 |
date_gmt | 文章发布的日期，以 GMT 时间显示。 |
slug | 文章的唯一字母数字标识符，针对其类型。 |
status | 文章的命名状态。 选项包括： publish、future、draft、pending、private |
password | 用于保护内容和摘要访问的密码。 |
title | 文章的标题。 |
content | 文章的内容。 |
author | 文章作者的 ID。 |
excerpt | 文章的摘要。 |
featured_media | 文章特色媒体的 ID。 |
comment_status | 是否允许对文章发表评论。 选项包括： open、closed |
ping_status | 是否允许对文章进行 Ping。 选项包括： open、closed |
format | 文章的格式。 选项包括： standard、aside、chat、gallery、link、image、quote、status、video、audio |
meta | 元数据字段。 |
sticky | 是否将文章视为置顶文章。 |
template | 用于显示文章的模板文件。 |
categories | 分配给该文章分类法中的术语。 |
tags | 分配给该文章 post_tag 分类法中的术语。 |
定义
POST /wp/v2/posts
检索文章
定义与示例请求
GET /wp/v2/posts/<id>
查询此端点以检索特定文章记录。
$ curl https://example.com/wp-json/wp/v2/posts/<id>
参数
id | 文章的唯一标识符。 |
context | 请求的作用域；决定响应中存在的字段。 默认值： 选项包括： |
password | 如果文章受密码保护，则为此密码。 |
更新文章
参数
id | 文章的唯一标识符。 |
date | 文章发布的日期，使用网站时区。 |
date_gmt | 文章发布的日期，以 GMT 时间显示。 |
slug | 文章的唯一字母数字标识符，针对其类型。 |
status | 文章的命名状态。 选项包括： publish、future、draft、pending、private |
password | 用于保护内容和摘要访问的密码。 |
title | 文章的标题。 |
content | 文章的内容。 |
author | 文章作者的 ID。 |
excerpt | 文章的摘要。 |
featured_media | 文章特色媒体的 ID。 |
comment_status | 是否允许对文章发表评论。 选项包括： open、closed |
ping_status | 是否允许对文章进行 Ping。 选项包括： open、closed |
format | 文章的格式。 选项包括： standard、aside、chat、gallery、link、image、quote、status、video、audio |
meta | 元数据字段。 |
sticky | 是否将文章视为置顶文章。 |
template | 用于显示文章的模板文件。 |
categories | 分配给该文章分类法中的术语。 |
tags | 分配给该文章 post_tag 分类法中的术语。 |
定义
POST /wp/v2/posts/<id>
示例请求
$ curl -X POST https://example.com/wp-json/wp/v2/posts/<id> -d '{"title":"My New Title"}'
删除文章
参数
id | 文章的唯一标识符。 |
force | 是否绕过回收站并强制删除。 |
定义
DELETE /wp/v2/posts/<id>
示例请求
$ curl -X DELETE https://example.com/wp-json/wp/v2/posts/<id>