* WordPress Administration Media API.
* @subpackage Administration
* Defines the default media upload tabs
* @return string[] Default tabs.
function media_upload_tabs() {
'type' => __( 'From Computer' ), // Handler action suffix => tab text.
'type_url' => __( 'From URL' ),
'gallery' => __( 'Gallery' ),
'library' => __( 'Media Library' ),
* Filters the available tabs in the legacy (pre-3.5.0) media popup.
* @param string[] $_default_tabs An array of media tabs.
return apply_filters( 'media_upload_tabs', $_default_tabs );
* Adds the gallery tab back to the tabs array if post has image attachments
* @global wpdb $wpdb WordPress database abstraction object.
* @return array $tabs with gallery if post has image attachment
function update_gallery_tab( $tabs ) {
if ( ! isset( $_REQUEST['post_id'] ) ) {
unset( $tabs['gallery'] );
$post_id = (int) $_REQUEST['post_id'];
$attachments = (int) $wpdb->get_var( $wpdb->prepare( "SELECT count(*) FROM $wpdb->posts WHERE post_type = 'attachment' AND post_status != 'trash' AND post_parent = %d", $post_id ) );
if ( empty( $attachments ) ) {
unset( $tabs['gallery'] );
/* translators: %s: Number of attachments. */
$tabs['gallery'] = sprintf( __( 'Gallery (%s)' ), "<span id='attachments-count'>$attachments</span>" );
* Outputs the legacy media upload tabs UI.
* @global string $redir_tab
function the_media_upload_tabs() {
$tabs = media_upload_tabs();
if ( ! empty( $tabs ) ) {
echo "<ul id='sidemenu'>\n";
if ( isset( $redir_tab ) && array_key_exists( $redir_tab, $tabs ) ) {
} elseif ( isset( $_GET['tab'] ) && array_key_exists( $_GET['tab'], $tabs ) ) {
/** This filter is documented in wp-admin/media-upload.php */
$current = apply_filters( 'media_upload_default_tab', $default );
foreach ( $tabs as $callback => $text ) {
if ( $current == $callback ) {
$class = " class='current'";
'post_mime_type' => false,
$link = "<a href='" . esc_url( $href ) . "'$class>$text</a>";
echo "\t<li id='" . esc_attr( "tab-$callback" ) . "'>$link</li>\n";
* Retrieves the image HTML to send to the editor.
* @param int $id Image attachment ID.
* @param string $caption Image caption.
* @param string $title Image title attribute.
* @param string $align Image CSS alignment property.
* @param string $url Optional. Image src URL. Default empty.
* @param bool|string $rel Optional. Value for rel attribute or whether to add a default value. Default false.
* @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of
* width and height values in pixels (in that order). Default 'medium'.
* @param string $alt Optional. Image alt attribute. Default empty.
* @return string The HTML output to insert into the editor.
function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $rel = false, $size = 'medium', $alt = '' ) {
$html = get_image_tag( $id, $alt, '', $align, $size );
if ( is_string( $rel ) ) {
$rel = ' rel="' . esc_attr( $rel ) . '"';
$rel = ' rel="attachment wp-att-' . (int) $id . '"';
$html = '<a href="' . esc_attr( $url ) . '"' . $rel . '>' . $html . '</a>';
* Filters the image HTML markup to send to the editor when inserting an image.
* @since 5.6.0 The `$rel` parameter was added.
* @param string $html The image HTML markup to send.
* @param int $id The attachment ID.
* @param string $caption The image caption.
* @param string $title The image title.
* @param string $align The image alignment.
* @param string $url The image source URL.
* @param string|int[] $size Requested image size. Can be any registered image size name, or
* an array of width and height values in pixels (in that order).
* @param string $alt The image alternative, or alt, text.
* @param string $rel The image rel attribute.
$html = apply_filters( 'image_send_to_editor', $html, $id, $caption, $title, $align, $url, $size, $alt, $rel );
* Adds image shortcode with caption to editor.
* @param string $html The image HTML markup to send.
* @param int $id Image attachment ID.
* @param string $caption Image caption.
* @param string $title Image title attribute (not used).
* @param string $align Image CSS alignment property.
* @param string $url Image source URL (not used).
* @param string $size Image size (not used).
* @param string $alt Image `alt` attribute (not used).
* @return string The image HTML markup with caption shortcode.
function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $alt = '' ) {
* Filters the caption text.
* Note: If the caption text is empty, the caption shortcode will not be appended
* to the image HTML when inserted into the editor.
* Passing an empty value also prevents the {@see 'image_add_caption_shortcode'}
* Filters from being evaluated at the end of image_add_caption().
* @param string $caption The original caption text.
* @param int $id The attachment ID.
$caption = apply_filters( 'image_add_caption_text', $caption, $id );
* Filters whether to disable captions.
* Prevents image captions from being appended to image HTML when inserted into the editor.
* @param bool $bool Whether to disable appending captions. Returning true from the filter
* will disable captions. Default empty string.
if ( empty( $caption ) || apply_filters( 'disable_captions', '' ) ) {
$id = ( 0 < (int) $id ) ? 'attachment_' . $id : '';
if ( ! preg_match( '/width=["\']([0-9]+)/', $html, $matches ) ) {
$caption = str_replace( array( "\r\n", "\r" ), "\n", $caption );
$caption = preg_replace_callback( '/<[a-zA-Z0-9]+(?: [^<>]+>)*/', '_cleanup_image_add_caption', $caption );
// Convert any remaining line breaks to <br />.
$caption = preg_replace( '/[ \n\t]*\n[ \t]*/', '<br />', $caption );
$html = preg_replace( '/(class=["\'][^\'"]*)align(none|left|right|center)\s?/', '$1', $html );
$shcode = '[caption id="' . $id . '" align="align' . $align . '" width="' . $width . '"]' . $html . ' ' . $caption . '[/caption]';
* Filters the image HTML markup including the caption shortcode.
* @param string $shcode The image HTML markup with caption shortcode.
* @param string $html The image HTML markup.
return apply_filters( 'image_add_caption_shortcode', $shcode, $html );
* Private preg_replace callback used in image_add_caption().
function _cleanup_image_add_caption( $matches ) {
// Remove any line breaks from inside the tags.
return preg_replace( '/[\r\n\t]+/', ' ', $matches[0] );
* Adds image HTML to editor.
function media_send_to_editor( $html ) {
<script type="text/javascript">
var win = window.dialogArguments || opener || parent || top;
win.send_to_editor( <?php echo wp_json_encode( $html ); ?> );
* Saves a file submitted from a POST request and create an attachment post for it.
* @param string $file_id Index of the `$_FILES` array that the file was sent. Required.
* @param int $post_id The post ID of a post to attach the media item to. Required, but can
* be set to 0, creating a media item that has no relationship to a post.
* @param array $post_data Optional. Overwrite some of the attachment.
* @param array $overrides Optional. Override the wp_handle_upload() behavior.
* @return int|WP_Error ID of the attachment or a WP_Error object on failure.
function media_handle_upload( $file_id, $post_id, $post_data = array(), $overrides = array( 'test_form' => false ) ) {
$time = current_time( 'mysql' );
$post = get_post( $post_id );
// The post date doesn't usually matter for pages, so don't backdate this upload.
if ( 'page' !== $post->post_type && substr( $post->post_date, 0, 4 ) > 0 ) {
$time = $post->post_date;
$file = wp_handle_upload( $_FILES[ $file_id ], $overrides, $time );
if ( isset( $file['error'] ) ) {
return new WP_Error( 'upload_error', $file['error'] );
$name = $_FILES[ $file_id ]['name'];
$ext = pathinfo( $name, PATHINFO_EXTENSION );
$name = wp_basename( $name, ".$ext" );
$title = sanitize_text_field( $name );
if ( preg_match( '#^audio#', $type ) ) {
$meta = wp_read_audio_metadata( $file );
if ( ! empty( $meta['title'] ) ) {
if ( ! empty( $title ) ) {
if ( ! empty( $meta['album'] ) && ! empty( $meta['artist'] ) ) {
/* translators: 1: Audio track title, 2: Album title, 3: Artist name. */
$content .= sprintf( __( '"%1$s" from %2$s by %3$s.' ), $title, $meta['album'], $meta['artist'] );
} elseif ( ! empty( $meta['album'] ) ) {
/* translators: 1: Audio track title, 2: Album title. */
$content .= sprintf( __( '"%1$s" from %2$s.' ), $title, $meta['album'] );
} elseif ( ! empty( $meta['artist'] ) ) {
/* translators: 1: Audio track title, 2: Artist name. */
$content .= sprintf( __( '"%1$s" by %2$s.' ), $title, $meta['artist'] );
/* translators: %s: Audio track title. */
$content .= sprintf( __( '"%s".' ), $title );
} elseif ( ! empty( $meta['album'] ) ) {
if ( ! empty( $meta['artist'] ) ) {
/* translators: 1: Audio album title, 2: Artist name. */
$content .= sprintf( __( '%1$s by %2$s.' ), $meta['album'], $meta['artist'] );
$content .= $meta['album'] . '.';
} elseif ( ! empty( $meta['artist'] ) ) {
$content .= $meta['artist'] . '.';
if ( ! empty( $meta['year'] ) ) {
/* translators: Audio file track information. %d: Year of audio track release. */
$content .= ' ' . sprintf( __( 'Released: %d.' ), $meta['year'] );
if ( ! empty( $meta['track_number'] ) ) {
$track_number = explode( '/', $meta['track_number'] );
if ( isset( $track_number[1] ) ) {
/* translators: Audio file track information. 1: Audio track number, 2: Total audio tracks. */
$content .= ' ' . sprintf( __( 'Track %1$s of %2$s.' ), number_format_i18n( $track_number[0] ), number_format_i18n( $track_number[1] ) );
/* translators: Audio file track information. %s: Audio track number. */
$content .= ' ' . sprintf( __( 'Track %s.' ), number_format_i18n( $track_number[0] ) );
if ( ! empty( $meta['genre'] ) ) {
/* translators: Audio file genre information. %s: Audio genre name. */
$content .= ' ' . sprintf( __( 'Genre: %s.' ), $meta['genre'] );
// Use image exif/iptc data for title and caption defaults if possible.
} elseif ( 0 === strpos( $type, 'image/' ) ) {
$image_meta = wp_read_image_metadata( $file );
if ( trim( $image_meta['title'] ) && ! is_numeric( sanitize_title( $image_meta['title'] ) ) ) {
$title = $image_meta['title'];
if ( trim( $image_meta['caption'] ) ) {
$excerpt = $image_meta['caption'];
// Construct the attachment array.
$attachment = array_merge(
'post_mime_type' => $type,
'post_parent' => $post_id,
'post_content' => $content,
'post_excerpt' => $excerpt,
// This should never be set as it would then overwrite an existing attachment.
unset( $attachment['ID'] );
$attachment_id = wp_insert_attachment( $attachment, $file, $post_id, true );
if ( ! is_wp_error( $attachment_id ) ) {
// Set a custom header with the attachment_id.
// Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
if ( ! headers_sent() ) {
header( 'X-WP-Upload-Attachment-ID: ' . $attachment_id );
// The image sub-sizes are created during wp_generate_attachment_metadata().
// This is generally slow and may cause timeouts or out of memory errors.
wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) );
* Handles a side-loaded file in the same way as an uploaded file is handled by media_handle_upload().
* @since 5.3.0 The `$post_id` parameter was made optional.
* @param string[] $file_array Array that represents a `$_FILES` upload array.
* @param int $post_id Optional. The post ID the media is associated with.
* @param string $desc Optional. Description of the side-loaded file. Default null.
* @param array $post_data Optional. Post data to override. Default empty array.
* @return int|WP_Error The ID of the attachment or a WP_Error on failure.
function media_handle_sideload( $file_array, $post_id = 0, $desc = null, $post_data = array() ) {
$overrides = array( 'test_form' => false );
if ( isset( $post_data['post_date'] ) && substr( $post_data['post_date'], 0, 4 ) > 0 ) {
$time = $post_data['post_date'];
$post = get_post( $post_id );
if ( $post && substr( $post->post_date, 0, 4 ) > 0 ) {
$time = $post->post_date;
$time = current_time( 'mysql' );
$file = wp_handle_sideload( $file_array, $overrides, $time );
if ( isset( $file['error'] ) ) {
return new WP_Error( 'upload_error', $file['error'] );
$title = preg_replace( '/\.[^.]+$/', '', wp_basename( $file ) );
// Use image exif/iptc data for title and caption defaults if possible.
$image_meta = wp_read_image_metadata( $file );
if ( trim( $image_meta['title'] ) && ! is_numeric( sanitize_title( $image_meta['title'] ) ) ) {
$title = $image_meta['title'];
if ( trim( $image_meta['caption'] ) ) {
$content = $image_meta['caption'];
// Construct the attachment array.
$attachment = array_merge(
'post_mime_type' => $type,
'post_parent' => $post_id,
'post_content' => $content,
// This should never be set as it would then overwrite an existing attachment.
unset( $attachment['ID'] );
// Save the attachment metadata.
$attachment_id = wp_insert_attachment( $attachment, $file, $post_id, true );
if ( ! is_wp_error( $attachment_id ) ) {