架构

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

date 帖子发布的日期(使用站点时区)。

JSON 数据类型:字符串或 null
格式:datetime (详细信息)

上下文:view、edit、embed

date_gmt 帖子发布的日期(GMT 时间)。

JSON 数据类型:字符串或 null
格式:datetime (详细信息)

上下文:view、edit

guid 帖子的全局唯一标识符。

JSON 数据类型:对象

只读

上下文:view、edit

id 帖子的唯一标识符。

JSON 数据类型:整数

只读

上下文:view、edit、embed

link 帖子的 URL。

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

只读

上下文:view、edit、embed

modified 帖子最后修改的日期(使用站点时区)。

JSON 数据类型:字符串
格式:datetime (详细信息)

只读

上下文:view、edit

modified_gmt 帖子最后修改的日期(GMT 时间)。

JSON 数据类型:字符串
格式:datetime (详细信息)

只读

上下文:view、edit

slug 帖子类型的字母数字标识符。

JSON 数据类型:字符串

上下文:view、edit、embed

status 帖子的命名状态。

JSON 数据类型:字符串

上下文:view、edit

其中之一:publish、future、draft、pending、private

type 帖子类型。

JSON 数据类型:字符串

只读

上下文:view、edit、embed

permalink_template 帖子的固定链接模板。

JSON 数据类型:字符串

只读

上下文:edit

generated_slug 根据帖子标题自动生成的 slug。

JSON 数据类型:字符串

只读

上下文:edit

title 帖子的标题。

JSON 数据类型:对象

上下文:view、edit、embed

author 帖子作者的 ID。

JSON 数据类型:整数

上下文:view、edit、embed

comment_status 帖子是否允许评论。

JSON 数据类型:字符串

上下文:view、edit

其中之一:open、closed

ping_status 帖子是否可以被 Ping。

JSON 数据类型:字符串

上下文:view、edit

其中之一:open、closed

meta 元数据字段。

JSON 数据类型:对象

上下文:view、edit

template 用于显示帖子的主题文件。

JSON 数据类型:字符串

上下文:view、edit

alt_text 附件未显示时显示的替代文本。

JSON 数据类型:字符串

上下文:view、edit、embed

caption 附件的标题。

JSON 数据类型:对象

上下文:view、edit、embed

description 附件的描述。

JSON 数据类型:对象

上下文:view、edit

media_type 附件类型。

JSON 数据类型:字符串

只读

上下文:view、edit、embed

其中之一:image、file

mime_type 附件的 MIME 类型。

JSON 数据类型:字符串

只读

上下文:view、edit、embed

media_details 关于媒体文件的详细信息,具体取决于其类型。

JSON 数据类型:对象

只读

上下文:view、edit、embed

post 附件关联帖子的 ID。

JSON 数据类型:整数

上下文:view、edit

source_url 原始附件文件的 URL。

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

只读

上下文:view、edit、embed

missing_image_sizes 附件缺失的图片尺寸列表。

JSON 数据类型:数组

只读

上下文:edit

列出媒体

查询此端点以检索媒体集合。您可以使用以下 URL 查询参数来控制和管理接收到的响应。

定义

GET /wp/v2/media

示例请求

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

参数

context 执行请求的范围;决定响应中存在的字段。

默认值:view

其中之一:view、embed、edit

page 集合的当前页码。

默认值:1

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

默认值:10

search 将结果限制为匹配特定字符串的项目。
after 将响应限制为在给定符合 ISO8601 标准的日期之后发布的帖子。
modified_after 将响应限制为在给定符合 ISO8601 标准的日期之后修改的帖子。
author 将结果集限制为分配给特定作者的文章。
author_exclude 确保结果集排除分配给特定作者的文章。
before 将响应限制为在给定符合 ISO8601 标准的日期之前发布的帖子。
modified_before 将响应限制为在给定符合 ISO8601 标准的日期之前修改的帖子。
exclude 确保结果集排除特定的 ID。
include 将结果集限制为特定的 ID。
offset 偏移结果集一定数量的项目。
order 排序属性升序或降序。

默认值:desc

其中之一:asc、desc

orderby 按帖子属性对集合进行排序。

默认值:date

其中之一:author、date、id、include、modified、parent、relevance、slug、include_slugs、title

parent 将结果集限制为具有特定父级 ID 的项目。
parent_exclude 将结果集限制为除特定父级 ID 之外的所有项目。
search_columns 要搜索的列名数组。
slug 将结果集限制为具有一或多个特定 slug 的帖子。
status 将结果集限制为分配了一个或多个状态的帖子。

默认值:inherit

media_type 将结果集限制为特定媒体类型的附件。
其中之一:image、video、text、application、audio
mime_type 将结果集限制为特定 MIME 类型的附件。

创建媒体项

参数

date 文章发布的日期,使用站点时区。
date_gmt 文章发布的日期,使用格林威治标准时间(GMT)。
slug 针对该类型唯一的文章字母数字标识符。
status 文章的命名状态。
可选值:publish、future、draft、pending、private
title 文章的标题。
author 文章作者的 ID。
comment_status 文章是否允许评论。
可选值:open、closed
ping_status 文章是否可被 Ping。
可选值:open、closed
meta 元数据字段。
template 用于显示文章的模板文件。
alt_text 附件未显示时显示的替代文本。
caption 附件的标题说明。
description 附件的描述。
post 附件关联的文章 ID。

定义

POST /wp/v2/media

检索媒体项

定义与示例请求

GET /wp/v2/media/<id>

查询此端点以检索特定的媒体项记录。

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

参数

id 文章的唯一标识符。
context 请求的作用域;决定响应中包含的字段。

默认值:view

可选值:view、embed、edit

更新媒体项

参数

id 文章的唯一标识符。
date 文章发布的日期,使用站点时区。
date_gmt 文章发布的日期,使用格林威治标准时间(GMT)。
slug 针对该类型唯一的文章字母数字标识符。
status 文章的命名状态。
可选值:publish、future、draft、pending、private
title 文章的标题。
author 文章作者的 ID。
comment_status 文章是否允许评论。
可选值:open、closed
ping_status 文章是否可被 Ping。
可选值:open、closed
meta 元数据字段。
template 用于显示文章的模板文件。
alt_text 附件未显示时显示的替代文本。
caption 附件的标题说明。
description 附件的描述。
post 附件关联的文章 ID。

定义

POST /wp/v2/media/<id>

示例请求

无

删除媒体项

参数

id 文章的唯一标识符。
force 是否绕过回收站并强制删除。

定义

DELETE /wp/v2/media/<id>

示例请求

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