媒体文件

最后更新于：2021-11-30 11:37:48

Media

结构

该结构定义了媒体文件项目数据中存在的所有字段。除非使用“_filter”查询参数构造字段，否则来自这些端点的任何响应都可以包含以下字段。

`date` string or null, datetime (details)	对象发布的日期，基于站点时区。 Context: `view`, `edit`, `embed`
`date_gmt` string or null, datetime (details)	对象发布的日期，以GMT为单位。 Context: `view`, `edit`
`guid` object	对象的全局唯一标识符。只读 Context: `view`, `edit`
`id` integer	对象的唯一标识符。只读 Context: `view`, `edit`, `embed`
`link` string, uri	对象的URL。只读 Context: `view`, `edit`, `embed`
`modified` string, datetime (details)	上次修改对象的日期，基于站点时区。只读 Context: `view`, `edit`
`modified_gmt` string, datetime (details)	上次修改对象的日期，以GMT为单位。只读 Context: `view`, `edit`
`slug` string	对象的字母数字标识符，其类型是唯一的。 Context: `view`, `edit`, `embed`
`status` string	对象的命名状态。 Context: `view`, `edit` 唯一: `publish`, `future`, `draft`, `pending`, `private`
`type` string	对象的文章类型。只读 Context: `view`, `edit`, `embed`
`permalink_template` string	对象的永久链接模板。只读 Context: `edit`
`generated_slug` string	对象标题自动生成的Slug。只读 Context: `edit`
`title` object	对象的标题。 Context: `view`, `edit`, `embed`
`author` integer	对象作者的ID。 Context: `view`, `edit`, `embed`
`comment_status` string	对象的是否开启评论。 Context: `view`, `edit` 唯一: `open`, `closed`
`ping_status` string	对象是否允许评论pingback。 Context: `view`, `edit` 唯一: `open`, `closed`
`meta` object	元字段。 Context: `view`, `edit`
`template` string	用于显示对象的主题文件。 Context: `view`, `edit`
`alt_text` string	Alternative text to display when attachment is not displayed. Context: `view`, `edit`, `embed`
`caption` object	The attachment caption. Context: `view`, `edit`, `embed`
`description` object	The attachment description. Context: `view`, `edit`
`media_type` string	Attachment type. 只读 Context: `view`, `edit`, `embed` 唯一: `image`, `file`
`mime_type` string	The attachment MIME type. 只读 Context: `view`, `edit`, `embed`
`media_details` object	Details about the media file, specific to its type. 只读 Context: `view`, `edit`, `embed`
`post` integer	The ID for the associated post of the attachment. Context: `view`, `edit`
`source_url` string, uri	URL to the original attachment file. 只读 Context: `view`, `edit`, `embed`
`missing_image_sizes` array	List of the missing image sizes of the attachment. 只读 Context: `edit`

媒体文件列表

查询此终结点以检索媒体文件集合。您收到的响应可以使用下面的URL查询参数进行控制和过滤。

定义

GET /gc/v2/media

请求示例

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

参数

`context`	提交请求的数据结构；明确响应字段结构。默认: `view` 唯一: `view`, `embed`, `edit`
`page`	集合的分页页码默认: `1`
`per_page`	返回结果集的最大条数。默认: `10`
`search`	字符串匹配的结果集。
`after`	限制对给定ISO8601合规日期后发布的文章的响应。
`author`	将将结果集限制为指定给特定作者的文章。
`author_exclude`	确保结果集不包括分配给特定作者的文章。
`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之外的所有项。
`slug`	将结果集限制为具有一个或多个特定段塞的文章。
`status`	将结果集限制为分配了一个或多个状态的文章。默认: `inherit`
`media_type`	Limit result set to attachments of a particular media type. 唯一: `image`, `video`, `text`, `application`, `audio`
`mime_type`	Limit result set to attachments of a particular MIME type.

创建媒体文件

参数

`date`	对象发布的日期，基于站点时区。
`date_gmt`	对象发布的日期，以GMT为单位。
`slug`	对象的字母数字标识符，其类型是唯一的。
`status`	对象的命名状态。唯一: `publish`, `future`, `draft`, `pending`, `private`
`title`	对象的标题。
`author`	对象作者的ID。
`comment_status`	对象的是否开启评论。唯一: `open`, `closed`
`ping_status`	对象是否允许评论pingback。唯一: `open`, `closed`
`meta`	元字段。
`template`	用于显示对象的主题文件。
`alt_text`	Alternative text to display when attachment is not displayed.
`caption`	The attachment caption.
`description`	The attachment description.
`post`	The ID for the associated post of the attachment.

定义

POST /gc/v2/media

检索媒体文件

定义 & 请求示例

GET /gc/v2/media/<id>

Query this endpoint to retrieve a specific Media Item record.

$ curl https://example.com/gc-json/gc/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`	对象是否允许评论pingback。唯一: `open`, `closed`
`meta`	元字段。
`template`	用于显示对象的主题文件。
`alt_text`	Alternative text to display when attachment is not displayed.
`caption`	The attachment caption.
`description`	The attachment description.
`post`	The ID for the associated post of the attachment.

定义

POST /gc/v2/media/<id>

请求示例

删除媒体文件

参数

`id`	对象的唯一标识符。
`force`	是否绕过垃圾箱并强制删除。

定义

DELETE /gc/v2/media/<id>

请求示例

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