Schema #Schema
The schema defines all the fields that exist for a comment object.
id
integer
Unique identifier for the object.
Read only
Context: view, edit, embed
author
integer
The id of the user object, if author was a user.
Context: view, edit, embed
author_email
string,
email
Email address for the object author.
Context: edit
author_ip
string,
ipv4
IP address for the object author.
Context: edit
author_name
string
Display name for the object author.
Context: view, edit, embed
author_url
string,
uri
URL for the object author.
Context: view, edit, embed
author_user_agent
string
User agent for the object author.
Read only
Context: edit
content
object
The content for the object.
Context: view, edit, embed
date
string,
datetime (ISO8601)
The date the object was published.
Context: view, edit, embed
date_gmt
string,
datetime (ISO8601)
The date the object was published as GMT.
Context: view, edit
karma
integer
Karma for the object.
Context: edit
link
string,
uri
URL to the object.
Read only
Context: view, edit, embed
parent
integer
The id for the parent of the object.
Context: view, edit, embed
post
integer
The id of the associated post object.
Context: view, edit
status
string
State of the object.
Context: view, edit
type
string
Type of Comment for the object.
Context: view, edit, embed
author_avatar_urls
object
Avatar URLs for the object author.
Read only
Context: view, edit, embed
meta
object
Meta fields.
Context: view, edit
Example Request #Example Request
$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/comments
Top ↑
List Comments #List Comments
Top ↑
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 resources published after a given ISO8601 compliant date.
author
Limit result set to comments assigned to specific user ids. Requires authorization.
author_exclude
Ensure result set excludes comments assigned to specific user ids. Requires authorization.
author_email
Limit result set to that from a specific author email. Requires authorization.
before
Limit response to resources published before a given ISO8601 compliant date.
exclude
Ensure result set excludes specific ids.
Default:
include
Limit result set to specific ids.
Default:
karma
Limit result set to that of a particular comment karma. Requires authorization.
offset
Offset the result set by a specific number of comments.
order
Order sort attribute ascending or descending.
Default: desc
One of: asc, desc
orderby
Sort collection by object attribute.
Default: date_gmt
One of: date, date_gmt, id, include, post, parent, type
parent
Limit result set to resources of specific parent ids.
Default:
parent_exclude
Ensure result set excludes specific parent ids.
Default:
post
Limit result set to resources assigned to specific post ids.
Default:
status
Limit result set to comments assigned a specific status. Requires authorization.
Default: approve
type
Limit result set to comments assigned a specific type. Requires authorization.
Default: comment
Top ↑
Definition #Definition
GET /wp/v2/comments
Example Request #Example Request
$ curl http://demo.wp-api.org/wp-json/wp/v2/comments
Top ↑
Retrieve a Comment #Retrieve a Comment
Top ↑
Arguments #Arguments
context
Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
Top ↑
Definition #Definition
GET /wp/v2/comments/<id>
Example Request #Example Request
$ curl http://demo.wp-api.org/wp-json/wp/v2/comments/<id>
Top ↑
Create a Comment #Create a Comment
Top ↑
Arguments #Arguments
author
The id of the user object, if author was a user.
author_email
Email address for the object author.
author_ip
IP address for the object author.
Default: 127.0.0.1
author_name
Display name for the object author.
author_url
URL for the object author.
content
The content for the object.
date
The date the object was published.
date_gmt
The date the object was published as GMT.
karma
Karma for the object.
parent
The id for the parent of the object.
Default: 0
post
The id of the associated post object.
Default: 0
status
State of the object.
type
Type of Comment for the object.
Default: comment
meta
Meta fields.
Top ↑
Definition #Definition
POST /wp/v2/comments
Top ↑
Update a Comment #Update a Comment
Top ↑
Arguments #Arguments
author
The id of the user object, if author was a user.
author_email
Email address for the object author.
author_ip
IP address for the object author.
author_name
Display name for the object author.
author_url
URL for the object author.
content
The content for the object.
date
The date the object was published.
date_gmt
The date the object was published as GMT.
karma
Karma for the object.
parent
The id for the parent of the object.
post
The id of the associated post object.
status
State of the object.
type
Type of Comment for the object.
meta
Meta fields.
Top ↑
Definition #Definition
POST /wp/v2/comments/<id>
Example Request #Example Request
Top ↑
Delete a Comment #Delete a Comment
Top ↑
Arguments #Arguments
force
Whether to bypass trash and force deletion.
Top ↑
Definition #Definition
DELETE /wp/v2/comments/<id>
Example Request #Example Request
$ curl -X DELETE http://demo.wp-api.org/wp-json/wp/v2/comments/<id>
- 简介
- 主题开发
- WordPress许可证
- 什么是主题
- 开发环境
- 主题开发示例
- 主题基础
- 模板文件
- 主样式表(style.css)
- 文章类型
- 规划主题文件
- 模板层级
- 模板标签
- 循环
- 主题函数
- 连接主题文件和目录
- 使用CSS和JavaScript
- 条件标签
- 类别,标签和自定义分类
- 模板文件
- 内容模板文件
- 页面模板文件
- 附件模板文件
- 自定义内容类型
- 部分和其他模板文件
- 评论模板
- 分类模板
- 404页面
- 主题功能
- 核心支持的功能
- 管理菜单
- 自定义Headers
- 自定义Logo
- 文章格式
- 置顶文章
- Sidebars
- Widgets
- 导航菜单
- 分页
- 媒体
- Audio
- Images
- Galleries
- Video
- 精选图片和缩略图
- 国际化
- 本地化
- 辅助功能
- 主题选项 – 自定义API
- 定制对象
- 改进用户体验的工具
- 定制JavaScript API
- JavaScript / Underscore.js渲染的自定义控件
- 高级用法
- 主题安全
- 数据消毒/逃避
- 数据验证
- 使用随机数
- 常见漏洞
- 高级主题
- 子主题
- UI最佳实践
- JavaScript最佳做法
- 主题单元测试
- 验证你的主题
- Plugin API Hooks
- 发布你的主题
- 所需的主题文件
- 测试
- 主题评论指南
- 写文档
- 提交你的主题到WordPress.org
- 参考文献
- 模板标签列表
- 条件标签列表
- 编码标准
- HTML编码标准
- CSS编码标准
- JavaScript编码标准
- PHP编码标准
- 插件开发
- 插件开发简介
- 什么是插件
- 插件基础
- 头部要求
- 包括软件许可证
- 启用 / 停用 Hooks
- 卸载方法
- 最佳做法
- 插件安全
- 检查用户功能
- 数据验证
- 保护输入
- 保护输出
- 随机数
- Hooks
- Actions
- Filters
- 自定义Hooks
- 高级主题
- 管理菜单
- 顶级菜单
- 子菜单
- 短代码
- 基本短码
- 封闭短码
- 带参数的短代码
- TinyMCE增强型短码
- 设置
- 设置API
- 使用设置API
- 选项API
- 自定义设置页面
- 元数据
- 管理帖子元数据
- 自定义元数据
- 渲染元数据
- 自定义文章类型
- 注册自定义文章类型
- 使用自定义文章类型
- 分类
- 使用自定义分类
- 在WP 4.2+中使用“split术语”
- 用户
- 创建和管理用户
- 使用用户元数据
- 角色和功能
- HTTP API
- JavaScript
- jQuery
- Ajax
- 服务器端PHP和入队
- Heartbeat API
- 概要
- 计划任务
- 了解WP-Cron计划
- 安排WP-Cron 事件
- 将WP-Cron挂接到系统任务计划程序中
- WP-Cron简单测试
- 国际化
- 本地化
- 如何国际化您的插件
- 国际化安全
- WordPress.org
- 详细插件指南
- 规划您的插件
- 如何使用Subversion
- 插件开发者常见问题
- 开发工具
- Debug Bar 和附加组件
- 辅助插件
- REST API手册
- 资源
- 文章
- 文章修订
- 文章类型
- 文章状态
- 类别
- 标签
- 页面
- 评论
- 分类
- 媒体
- 用户
- 设置
- 使用REST API
- 全局参数
- 分页
- 链接和嵌入
- 发现
- 认证
- 经常问的问题
- 骨干JavaScript客户端
- 客户端库
- 扩展REST API
- 添加自定义端点
- 自定义内容类型
- 修改回应
- 模式
- 词汇表
- 路由和端点
- 控制器类