Media
Edit
Topics
Schema
The schema defines all the fields that exist within a Media Item record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
date string or null, datetime (details) |
The date the post was published, in the site's timezone.
Context: |
date_gmt string or null, datetime (details) |
The date the post was published, as GMT.
Context: |
guid object |
The globally unique identifier for the post.
Read only Context: |
id integer |
Unique identifier for the post.
Read only Context: |
link string, uri |
URL to the post.
Read only Context: |
modified string, datetime (details) |
The date the post was last modified, in the site's timezone.
Read only Context: |
modified_gmt string, datetime (details) |
The date the post was last modified, as GMT.
Read only Context: |
slug string |
An alphanumeric identifier for the post unique to its type.
Context: |
status string |
A named status for the post.
Context: One of: |
type string |
Type of post.
Read only Context: |
permalink_template string |
Permalink template for the post.
Read only Context: |
generated_slug string |
Slug automatically generated from the post title.
Read only Context: |
title object |
The title for the post.
Context: |
author integer |
The ID for the author of the post.
Context: |
comment_status string |
Whether or not comments are open on the post.
Context: One of: |
ping_status string |
Whether or not the post can be pinged.
Context: One of: |
meta object |
Meta fields.
Context: |
template string |
The theme file to use to display the post.
Context: |
alt_text string |
Alternative text to display when attachment is not displayed.
Context: |
caption object |
The attachment caption.
Context: |
description object |
The attachment description.
Context: |
media_type string |
Attachment type.
Read only Context: One of: |
mime_type string |
The attachment MIME type.
Read only Context: |
media_details object |
Details about the media file, specific to its type.
Read only Context: |
post integer |
The ID for the associated post of the attachment.
Context: |
source_url string, uri |
URL to the original attachment file.
Read only Context: |
missing_image_sizes array |
List of the missing image sizes of the attachment.
Read only Context: |
List Media
Query this endpoint to retrieve a collection of media. The response you receive can be controlled and filtered using the URL query parameters below.
Definition
GET /wp/v2/media
Example Request
$ curl https://example.com/wp-json/wp/v2/media
Arguments
context
|
Scope under which the request is made; determines fields present in response.
Default: One of: |
page
|
Current page of the collection.
Default: |
per_page
|
Maximum number of items to be returned in result set.
Default: |
search
|
Limit results to those matching a string. |
after
|
Limit response to posts published after a given ISO8601 compliant date. |
modified_after
|
Limit response to posts modified after a given ISO8601 compliant date. |
author
|
Limit result set to posts assigned to specific authors. |
author_exclude
|
Ensure result set excludes posts assigned to specific authors. |
before
|
Limit response to posts published before a given ISO8601 compliant date. |
modified_before
|
Limit response to posts modified before a given ISO8601 compliant date. |
exclude
|
Ensure result set excludes specific IDs. |
include
|
Limit result set to specific IDs. |
offset
|
Offset the result set by a specific number of items. |
order
|
Order sort attribute ascending or descending.
Default: One of: |
orderby
|
Sort collection by post attribute.
Default: One of: |
parent
|
Limit result set to items with particular parent IDs. |
parent_exclude
|
Limit result set to all items except those of a particular parent ID. |
search_columns
|
Array of column names to be searched. |
slug
|
Limit result set to posts with one or more specific slugs. |
status
|
Limit result set to posts assigned one or more statuses.
Default: |
media_type
|
Limit result set to attachments of a particular media type. One of: image , video , text , application , audio
|
mime_type
|
Limit result set to attachments of a particular MIME type. |
Create a Media Item
Arguments
date
|
The date the post was published, in the site's timezone. |
date_gmt
|
The date the post was published, as GMT. |
slug
|
An alphanumeric identifier for the post unique to its type. |
status
|
A named status for the post. One of: publish , future , draft , pending , private
|
title
|
The title for the post. |
author
|
The ID for the author of the post. |
comment_status
|
Whether or not comments are open on the post. One of: open , closed
|
ping_status
|
Whether or not the post can be pinged. One of: open , closed
|
meta
|
Meta fields. |
template
|
The theme file to use to display the post. |
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. |
Definition
POST /wp/v2/media
Retrieve a Media Item
Definition & Example Request
GET /wp/v2/media/<id>
Query this endpoint to retrieve a specific Media Item record.
$ curl https://example.com/wp-json/wp/v2/media/<id>
Update a Media Item
Arguments
id
|
Unique identifier for the post. |
date
|
The date the post was published, in the site's timezone. |
date_gmt
|
The date the post was published, as GMT. |
slug
|
An alphanumeric identifier for the post unique to its type. |
status
|
A named status for the post. One of: publish , future , draft , pending , private
|
title
|
The title for the post. |
author
|
The ID for the author of the post. |
comment_status
|
Whether or not comments are open on the post. One of: open , closed
|
ping_status
|
Whether or not the post can be pinged. One of: open , closed
|
meta
|
Meta fields. |
template
|
The theme file to use to display the post. |
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. |
Delete a Media Item
Arguments
id
|
Unique identifier for the post. |
force
|
Whether to bypass Trash and force deletion. |
Definition
DELETE /wp/v2/media/<id>
Example Request
$ curl -X DELETE https://example.com/wp-json/wp/v2/media/<id>