评论

图式

该模式定义了评论记录中存在的所有字段。除非使用“_filter”查询参数或模式字段仅出现在特定上下文中,否则来自这些端点的任何响应都应包含以下字段。

id 整数对象的唯一标识符。 只读 上下文:view, edit,embed
author 整数用户对象的 ID,如果作者是用户。 上下文:view, edit,embed
author_email 字符串, 电子邮件对象作者的电子邮件地址。 语境:edit
author_ip 字符串, IP对象作者的 IP 地址。 语境:edit
author_name 细绳对象作者的显示名称。 上下文:view, edit,embed
author_url 字符串, uri对象作者的 URL。 上下文:view, edit,embed
author_user_agent 细绳对象作者的用户代理。 语境:edit
content 目的对象的内容。 上下文:view, edit,embed
date 字符串, 日期时间(详细信息)对象发布的日期,以站点的时区表示。 上下文:view, edit,embed
date_gmt 字符串, 日期时间(详细信息)对象发布的日期,作为 GMT。 上下文: view,edit
link 字符串, uri对象的 URL。 只读 上下文:view, edit,embed
parent 整数对象父对象的 ID。 上下文:view, edit,embed
post 整数关联的帖子对象的 ID。 上下文: view,edit
status 细绳对象的状态。 上下文: view,edit
type 细绳对象的注释类型。 只读 上下文:view, edit,embed
author_avatar_urls 目的对象作者的头像 URL。 只读 上下文:view, edit,embed
meta 目的元字段。 上下文: view,edit

列出评论

查询此端点以检索评论集合。可以使用下面的 URL 查询参数控制和过滤您收到的响应。

定义

GET /wp/v2/comments

示例请求

$ curl https://example.com/wp-json/wp/v2/comments

参数

context提出请求的范围;确定响应中存在的字段。 默认:view 其中之一:view, embed,edit
page集合的当前页面。 默认:1
per_page结果集中要返回的最大项目数。 默认:10
search将结果限制为与字符串匹配的结果。
after限制对给定 ISO8601 合规日期之后发布的评论的回应。
author将结果集限制为分配给特定用户 ID 的评论。需要授权。
author_exclude确保结果集不包括分配给特定用户 ID 的评论。需要授权。
author_email将结果集限制为来自特定作者电子邮件的结果集。需要授权。
before限制对给定 ISO8601 合规日期之前发布的评论的回应。
exclude确保结果集排除特定 ID。
include将结果集限制为特定 ID。
offset按特定数量的项目偏移结果集。
orderOrder 排序属性升序或降序。 默认:desc 其中之一:asc,desc
orderby按对象属性对集合进行排序。 默认:date_gmt 其中之一:date,,,,,,,, date_gmt_ id_ _includepostparenttype
parent将结果集限制为特定父 ID 的评论。
parent_exclude确保结果集排除特定的父 ID。
post将结果集限制为分配给特定帖子 ID 的评论。
status将结果集限制为分配了特定状态的评论。需要授权。 默认:approve
type将结果集限制为分配了特定类型的评论。需要授权。 默认:comment
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元字段。

定义

POST /wp/v2/comments

检索评论

定义和示例请求

GET /wp/v2/comments/<id>

查询此端点以检索特定评论记录。

$ curl https://example.com/wp-json/wp/v2/comments/<id>

参数

id对象的唯一标识符。
context提出请求的范围;确定响应中存在的字段。 默认:view 其中之一:view, embed,edit
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>