架构

架构定义了类别记录中存在的所有字段。除非使用 `_filter` 查询参数或架构字段仅出现在特定上下文中,否则预期这些端点的任何响应都将包含以下字段。

id 术语的唯一标识符。

JSON 数据类型:整数

只读

上下文:view, embed, edit

count 该术语已发布文章的数量。

JSON 数据类型:整数

只读

上下文:view, edit

description 术语的 HTML 描述。

JSON 数据类型:字符串

上下文:view, edit

link 术语的 URL。

JSON 数据类型:字符串,
格式:uri

只读

上下文:view, embed, edit

name 术语的 HTML 标题。

JSON 数据类型:字符串

上下文:view, embed, edit

slug 术语的字母数字标识符,对其类型是唯一的。

JSON 数据类型:字符串

上下文:view, embed, edit

taxonomy 术语的类型归属。

JSON 数据类型:字符串

只读

上下文:view, embed, edit

之一:category

parent 父级术语 ID。

JSON 数据类型:整数

上下文:view, edit

meta 元数据字段。

JSON 数据类型:对象

上下文:view, edit

列出类别

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

定义

GET /wp/v2/categories

示例请求

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

参数

context 请求的作用域;决定响应中存在的字段。

默认值:view

之一:view, embed, edit

page 集合的当前页码。

默认值:1

per_page 结果集中返回的最大项目数。

默认值:10

search 将结果限制为匹配某个字符串的项。
exclude 确保结果集排除特定的 ID。
include 将结果集限制为特定的 ID。
order 排序属性的升序或降序。

默认值:asc

之一:asc, desc

orderby 按术语属性对集合进行排序。

默认值:name

之一:id, include, name, slug, include_slugs, term_group, description, count

hide_empty 是否隐藏未分配给任何文章的术语。
parent 将结果集限制为分配给特定父级的术语。
post 将结果集限制为分配给特定文章的术语。
slug 将结果集限制为具有一个或多个特定 slugs 的术语。

创建类别

参数

description 术语的 HTML 描述。
name 术语的 HTML 标题。

必需:1

slug 术语的字母数字标识符,对其类型是唯一的。
parent 父级术语 ID。
meta 元数据字段。

定义

POST /wp/v2/categories

检索类别

定义 & 示例请求

GET /wp/v2/categories/<id>

查询此端点以检索特定的类别记录。

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

参数

id 术语的唯一标识符。
context 请求的作用域;决定响应中存在的字段。

默认值:view

之一:view, embed, edit

更新类别

参数

id 术语的唯一标识符。
description 术语的 HTML 描述。
name 术语的 HTML 标题。
slug 术语的字母数字标识符,对其类型是唯一的。
parent 父级术语 ID。
meta 元数据字段。

定义

POST /wp/v2/categories/<id>

示例请求

无

删除类别

参数

id 术语的唯一标识符。
force 必须为 true,因为术语不支持移至回收站。

定义

DELETE /wp/v2/categories/<id>

示例请求

$ curl -X DELETE https://example.com/wp-json/wp/v2/categories/<id>