架构

架构定义了标签记录中存在的所有字段。除非使用了 `_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

之一:post_tag

meta 元数据字段。

JSON 数据类型:对象

上下文:view, edit

列出标签

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

定义

GET /wp/v2/tags

示例请求

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

参数

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

默认值:view

之一:view, embed, edit

page 集合的当前页码。

默认值:1

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

默认值:10

search 将结果限制为与某字符串匹配的项目。
exclude 确保结果集排除特定的 ID。
include 将结果集限制为特定的 ID。
offset 偏移结果集指定的项目数量。
order 排序属性升序或降序。

默认值:asc

之一:asc, desc

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

默认值:name

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

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

创建标签

参数

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

必需:是

slug 术语的字母数字标识符,在其类型中唯一。
meta 元数据字段。

定义

POST /wp/v2/tags

检索标签

定义与示例请求

GET /wp/v2/tags/<id>

查询此端点以检索特定的标签记录。

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

参数

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

默认值:view

之一:view, embed, edit

更新标签

参数

id 术语的唯一标识符。
description 术语的 HTML 描述。
name 术语的 HTML 标题。
slug 术语的字母数字标识符,在其类型中唯一。
meta 元数据字段。

定义

POST /wp/v2/tags/<id>

示例请求

无

删除标签

参数

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

定义

DELETE /wp/v2/tags/<id>

示例请求

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