POST /sites/$site/media/$media_ID/delete

Delete a piece of media. Note: Media is deleted and not trashed.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/media/$media_ID/delete
Requires authentication? Yes

Method Parameters

Parameter Type Description
$site (int|string) Site ID or domain
$media_ID (int) The media ID

Query Parameters

Parameter Type Description
context (string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
false:
(default)
true:
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.

Response Parameters

Parameter Type Description
status (string) Returns deleted if the media was successfully deleted
ID (int) The ID of the media item
date (iso 8601 datetime) The date the media was uploaded
post_ID (int) ID of the post this media is attached to
author_ID (int) ID of the user who uploaded the media
URL (string) URL to the file
guid (string) Unique identifier
file (string) File name
extension (string) File extension
mime_type (string) File mime type
title (string) File name
caption (string) User-provided caption of the file
description (string) Description of the file
alt (string) Alternative text for image files.
thumbnails (object) Media item thumbnail URL options
height (int) (Image & video only) Height of the media item
width (int) (Image & video only) Width of the media item
length (int) (Video & audio only) Duration of the media item, in seconds
exif (array) (Image & audio only) Exif (meta) information about the media item
videopress_guid (string) (Video only) VideoPress GUID of the video when uploaded on a blog with VideoPress
videopress_processing_done (bool) (Video only) If the video is Uuploaded on a blog with VideoPress, this will return the status of processing on the Video

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
403 unauthorized User cannot access this private blog.
403 unauthorized User cannot access this restricted blog
403 unauthorized User is not authorized delete media
404 unknown_media Unknown Media

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/media/$media_ID/delete'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
    ),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1.1/sites/82974409/media/$media_ID/delete',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "ID": 14134,
    "URL": "https:\/\/apiexamples.files.wordpress.com\/2017\/06\/codeispoetry-rgb-3.png",
    "guid": "http:\/\/apiexamples.files.wordpress.com\/2017\/06\/codeispoetry-rgb-3.png",
    "date": "2017-06-28T06:01:49+00:00",
    "post_ID": 0,
    "author_ID": 0,
    "file": "codeispoetry-rgb-3.png",
    "mime_type": "image\/png",
    "extension": "png",
    "title": "codeispoetry-rgb-3",
    "caption": "",
    "description": "",
    "alt": "",
    "icon": "https:\/\/s1.wp.com\/wp-includes\/images\/media\/default.png",
    "thumbnails": {
        "thumbnail": "https:\/\/apiexamples.files.wordpress.com\/2017\/06\/codeispoetry-rgb-3.png?w=150",
        "medium": "https:\/\/apiexamples.files.wordpress.com\/2017\/06\/codeispoetry-rgb-3.png?w=300",
        "large": "https:\/\/apiexamples.files.wordpress.com\/2017\/06\/codeispoetry-rgb-3.png?w=500"
    },
    "height": 34,
    "width": 500,
    "exif": {
        "aperture": "0",
        "credit": "",
        "camera": "",
        "caption": "",
        "created_timestamp": "0",
        "copyright": "",
        "focal_length": "0",
        "iso": "0",
        "shutter_speed": "0",
        "title": "",
        "orientation": "0",
        "keywords": []
    },
    "meta": {
        "links": {
            "self": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/media\/14134",
            "help": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409\/media\/14134\/help",
            "site": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/82974409"
        }
    },
    "status": "deleted"
}