架构
Schema 定义了评论记录中存在的所有字段。除非使用了 `_filter` 查询参数，或者该 schema 字段仅出现在特定上下文中，否则来自这些端点的响应都应包含以下字段。
id | 评论的唯一标识符。 JSON 数据类型：integer 只读 上下文： |
author | 如果作者为用户，则为用户对象的 ID。 JSON 数据类型：integer 上下文： |
author_email | 评论作者的电子邮件地址。 JSON 数据类型：string, 上下文： |
author_ip | 评论作者的 IP 地址。 JSON 数据类型：string, 上下文： |
author_name | 评论作者的显示名称。 JSON 数据类型：string 上下文： |
author_url | 评论作者的 URL。 JSON 数据类型：string, 上下文： |
author_user_agent | 评论作者的用户代理。 JSON 数据类型：string 上下文： |
content | 评论内容。 JSON 数据类型：object 上下文： |
date | 评论发布的日期（使用站点时区）。 JSON 数据类型：string, 上下文： |
date_gmt | 评论发布的日期（GMT 时间）。 JSON 数据类型：string, 上下文： |
link | 评论的 URL。 JSON 数据类型：string, 只读 上下文： |
parent | 评论父项的 ID。 JSON 数据类型：integer 上下文： |
post | 关联帖子对象的 ID。 JSON 数据类型：integer 上下文： |
status | 评论的状态。 JSON 数据类型：string 上下文： |
type | 评论的类型。 JSON 数据类型：string 只读 上下文： |
author_avatar_urls | 评论作者的头像 URL。 JSON 数据类型：object 只读 上下文： |
meta | Meta 字段。 JSON 数据类型：object 上下文： |
评论列表
查询此端点以检索评论集合。您可以使用以下 URL 查询参数来控制和过滤接收到的响应。
定义
GET /wp/v2/comments
请求示例
$ curl https://example.com/wp-json/wp/v2/comments
参数
context | 请求的作用域；确定响应中存在的字段。 默认值： 可选值： |
page | 集合的当前页码。 默认值： |
per_page | 结果集中返回的最大项目数。 默认值： |
search | 将结果限制为匹配指定字符串的记录。 |
after | 将响应限制为在给定 ISO8601 合规日期之后发布的评论。 |
author | 将结果集限制为分配给特定用户 ID 的评论。需要授权。 |
author_exclude | 确保结果集排除分配给特定用户 ID 的评论。需要授权。 |
author_email | 将结果集限制为来自特定作者电子邮件的评论。需要授权。 |
before | 将响应限制为在给定 ISO8601 合规日期之前发布的评论。 |
exclude | 确保结果集排除特定的 ID。 |
include | 将结果集限制为特定的 ID。 |
offset | 通过特定数量的项目偏移结果集。 |
order | 排序属性按升序或降序排列。 默认值： 可选值： |
orderby | 按评论属性对集合进行排序。 默认值： 可选值： |
parent | 将结果集限制为特定父级 ID 的评论。 |
parent_exclude | 确保结果集排除特定的父级 ID。 |
post | 将结果集限制为分配给特定帖子 ID 的评论。 |
status | 将结果集限制为具有特定状态的评论。需要授权。 默认值： |
type | 将结果集限制为具有特定类型的评论。需要授权。 默认值： |
password | 如果帖子受密码保护，则为帖子的密码。 |
创建评论
参数
author | 如果作者为用户，则为用户对象的 ID。 |
author_email | 评论作者的电子邮件地址。 |
author_ip | 评论作者的 IP 地址。 |
author_name | 评论作者的显示名称。 |
author_url | 评论作者的 URL。 |
author_user_agent | 评论作者的用户代理。 |
content | 评论内容。 |
date | 评论发布的日期（使用站点时区）。 |
date_gmt | 评论发布的日期（GMT 时间）。 |
parent | 评论父项的 ID。 |
post | 关联帖子对象的 ID。 |
status | 评论的状态。 |
meta | Meta 字段。 |
定义
POST /wp/v2/comments
检索评论
定义 & 请求示例
GET /wp/v2/comments/<id>
查询此端点以检索特定的评论记录。
$ curl https://example.com/wp-json/wp/v2/comments/<id>
参数
id | 评论的唯一标识符。 |
context | 请求的作用域；确定响应中存在的字段。 默认值： 可选值： |
password | 评论父级帖子的密码（如果帖子受密码保护）。 |
更新评论
参数
id | 评论的唯一标识符。 |
author | 如果作者是用户，则为该用户对象的 ID。 |
author_email | 评论作者的电子邮件地址。 |
author_ip | 评论作者的 IP 地址。 |
author_name | 评论作者的显示名称。 |
author_url | 评论作者的 URL。 |
author_user_agent | 评论作者的用户代理。 |
content | 评论内容。 |
date | 评论发布的日期，使用网站时区。 |
date_gmt | 评论发布的日期，以 GMT 时间表示。 |
parent | 评论父级对象的 ID。 |
post | 关联帖子对象的 ID。 |
status | 评论的状态。 |
meta | 元数据字段。 |
定义
POST /wp/v2/comments/<id>
示例请求
无
删除评论
参数
id | 评论的唯一标识符。 |
force | 是否绕过垃圾桶并强制删除。 |
password | 评论所属父帖子的密码（如果帖子受密码保护）。 |
定义
DELETE /wp/v2/comments/<id>
示例请求
$ curl -X DELETE https://example.com/wp-json/wp/v2/comments/<id>