X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..refs/tags/wordpress-4.4:/wp-admin/includes/media.php diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php index 06cd1c12..9990b9fd 100644 --- a/wp-admin/includes/media.php +++ b/wp-admin/includes/media.php @@ -36,6 +36,8 @@ function media_upload_tabs() { * * @since 2.5.0 * + * @global wpdb $wpdb WordPress database abstraction object. + * * @param array $tabs * @return array $tabs with gallery if post has image attachment */ @@ -61,12 +63,13 @@ function update_gallery_tab($tabs) { return $tabs; } -add_filter('media_upload_tabs', 'update_gallery_tab'); /** - * {@internal Missing Short Description}} + * Outputs the legacy media upload tabs UI. * * @since 2.5.0 + * + * @global string $redir_tab */ function the_media_upload_tabs() { global $redir_tab; @@ -99,25 +102,30 @@ function the_media_upload_tabs() { } /** - * {@internal Missing Short Description}} + * Retrieves the image HTML to send to the editor. * * @since 2.5.0 * - * @param integer $id image attachment id - * @param string $caption image caption - * @param string $alt image alt attribute - * @param string $title image title attribute - * @param string $align image css alignment property - * @param string $url image src url - * @param string|bool $rel image rel attribute - * @param string $size image size (thumbnail, medium, large, full or added with add_image_size() ) - * @return string the html to insert into 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 string $rel Optional. Image rel attribute. Default empty. + * @param string|array $size Optional. Image size. Accepts any valid image size, 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 = '') { +function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $rel = '', $size = 'medium', $alt = '' ) { $html = get_image_tag($id, $alt, '', $align, $size); - $rel = $rel ? ' rel="attachment wp-att-' . esc_attr($id).'"' : ''; + if ( ! $rel ) { + $rel = ' rel="attachment wp-att-' . esc_attr( $id ) . '"'; + } else { + $rel = ' rel="' . esc_attr( $rel ) . '"'; + } if ( $url ) $html = '$html"; @@ -127,14 +135,15 @@ function get_image_send_to_editor($id, $caption, $title, $align, $url='', $rel = * * @since 2.5.0 * - * @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 $size The image size. - * @param string $alt The image alternative, or alt, text. + * @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|array $size Size of image. Image size or array of width and height values + * (in that order). Default 'medium'. + * @param string $alt The image alternative, or alt, text. */ $html = apply_filters( 'image_send_to_editor', $html, $id, $caption, $title, $align, $url, $size, $alt ); @@ -158,6 +167,22 @@ function get_image_send_to_editor($id, $caption, $title, $align, $url='', $rel = */ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $alt = '' ) { + /** + * Filter 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'} + * filter from being evaluated at the end of {@see image_add_caption()}. + * + * @since 4.1.0 + * + * @param string $caption The original caption text. + * @param int $id The attachment ID. + */ + $caption = apply_filters( 'image_add_caption_text', $caption, $id ); + /** * Filter whether to disable captions. * @@ -180,7 +205,8 @@ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $ $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
+ + // Convert any remaining line breaks to
. $caption = preg_replace( '/[ \n\t]*\n[ \t]*/', '
', $caption ); $html = preg_replace( '/(class=["\'][^\'"]*)align(none|left|right|center)\s?/', '$1', $html ); @@ -199,7 +225,6 @@ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $ */ return apply_filters( 'image_add_caption_shortcode', $shcode, $html ); } -add_filter( 'image_send_to_editor', 'image_add_caption', 20, 8 ); /** * Private preg_replace callback used in image_add_caption() @@ -208,7 +233,7 @@ add_filter( 'image_send_to_editor', 'image_add_caption', 20, 8 ); * @since 3.4.0 */ function _cleanup_image_add_caption( $matches ) { - // remove any line breaks from inside the tags + // Remove any line breaks from inside the tags. return preg_replace( '/[\r\n\t]+/', ' ', $matches[0] ); } @@ -222,24 +247,23 @@ function _cleanup_image_add_caption( $matches ) { function media_send_to_editor($html) { ?> false )) { @@ -264,31 +288,31 @@ function media_handle_upload($file_id, $post_id, $post_data = array(), $override $file = $file['file']; $title = $name; $content = ''; + $excerpt = ''; if ( preg_match( '#^audio#', $type ) ) { $meta = wp_read_audio_metadata( $file ); - if ( ! empty( $meta['title'] ) ) + if ( ! empty( $meta['title'] ) ) { $title = $meta['title']; - - $content = ''; + } 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'] ); - } else if ( ! empty( $meta['album'] ) ) { + } elseif ( ! empty( $meta['album'] ) ) { /* translators: 1: audio track title, 2: album title */ $content .= sprintf( __( '"%1$s" from %2$s.' ), $title, $meta['album'] ); - } else if ( ! empty( $meta['artist'] ) ) { + } elseif ( ! empty( $meta['artist'] ) ) { /* translators: 1: audio track title, 2: artist name */ $content .= sprintf( __( '"%1$s" by %2$s.' ), $title, $meta['artist'] ); } else { $content .= sprintf( __( '"%s".' ), $title ); } - } else if ( ! empty( $meta['album'] ) ) { + } elseif ( ! empty( $meta['album'] ) ) { if ( ! empty( $meta['artist'] ) ) { /* translators: 1: audio album title, 2: artist name */ @@ -297,7 +321,7 @@ function media_handle_upload($file_id, $post_id, $post_data = array(), $override $content .= $meta['album'] . '.'; } - } else if ( ! empty( $meta['artist'] ) ) { + } elseif ( ! empty( $meta['artist'] ) ) { $content .= $meta['artist'] . '.'; @@ -317,12 +341,15 @@ function media_handle_upload($file_id, $post_id, $post_data = array(), $override if ( ! empty( $meta['genre'] ) ) $content .= ' ' . sprintf( __( 'Genre: %s.' ), $meta['genre'] ); - // use image exif/iptc data for title and caption defaults if possible - } elseif ( $image_meta = @wp_read_image_metadata( $file ) ) { - if ( trim( $image_meta['title'] ) && ! is_numeric( sanitize_title( $image_meta['title'] ) ) ) + // 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'] ) ) - $content = $image_meta['caption']; + } + + if ( trim( $image_meta['caption'] ) ) { + $excerpt = $image_meta['caption']; + } } // Construct the attachment array @@ -332,11 +359,11 @@ function media_handle_upload($file_id, $post_id, $post_data = array(), $override 'post_parent' => $post_id, 'post_title' => $title, 'post_content' => $content, + 'post_excerpt' => $excerpt, ), $post_data ); // This should never be set as it would then overwrite an existing attachment. - if ( isset( $attachment['ID'] ) ) - unset( $attachment['ID'] ); + unset( $attachment['ID'] ); // Save the data $id = wp_insert_attachment($attachment, $file, $post_id); @@ -378,7 +405,7 @@ function media_handle_sideload($file_array, $post_id, $desc = null, $post_data = $title = preg_replace('/\.[^.]+$/', '', basename($file)); $content = ''; - // use image exif/iptc data for title and caption defaults if possible + // Use image exif/iptc data for title and caption defaults if possible. if ( $image_meta = @wp_read_image_metadata($file) ) { if ( trim( $image_meta['title'] ) && ! is_numeric( sanitize_title( $image_meta['title'] ) ) ) $title = $image_meta['title']; @@ -389,7 +416,7 @@ function media_handle_sideload($file_array, $post_id, $desc = null, $post_data = if ( isset( $desc ) ) $title = $desc; - // Construct the attachment array + // Construct the attachment array. $attachment = array_merge( array( 'post_mime_type' => $type, 'guid' => $url, @@ -399,8 +426,7 @@ function media_handle_sideload($file_array, $post_id, $desc = null, $post_data = ), $post_data ); // This should never be set as it would then overwrite an existing attachment. - if ( isset( $attachment['ID'] ) ) - unset( $attachment['ID'] ); + unset( $attachment['ID'] ); // Save the attachment metadata $id = wp_insert_attachment($attachment, $file, $post_id); @@ -415,7 +441,9 @@ function media_handle_sideload($file_array, $post_id, $desc = null, $post_data = * * @since 2.5.0 * - * @param array $content_func + * @global int $body_id + * + * @param string|callable $content_func */ function wp_iframe($content_func /* ... */) { _wp_admin_html_begin(); @@ -431,11 +459,9 @@ if ( ( is_array( $content_func ) && ! empty( $content_func[1] ) && 0 === strpos( wp_enqueue_style( 'ie' ); ?> '; - echo '' . $img . __( 'Add Media' ) . ''; - + $id_attribute = $instance === 1 ? ' id="insert-media-button"' : ''; + printf( '', + $id_attribute, + esc_attr( $editor_id ), + $img . __( 'Add Media' ) + ); /** * Filter the legacy (pre-3.5.0) media buttons. * @@ -543,8 +580,15 @@ function media_buttons($editor_id = 'content') { echo $legacy_filter; } } -add_action( 'media_buttons', 'media_buttons' ); +/** + * + * @global int $post_ID + * @param string $type + * @param int $post_id + * @param string $tab + * @return string + */ function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) { global $post_ID; @@ -562,7 +606,7 @@ function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) { /** * Filter the upload iframe source URL for a specific media type. * - * The dynamic portion of the hook name, $type, refers to the type + * The dynamic portion of the hook name, `$type`, refers to the type * of media uploaded. * * @since 3.0.0 @@ -575,7 +619,7 @@ function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) { } /** - * {@internal Missing Short Description}} + * Handles form submissions for the legacy media uploader. * * @since 2.5.0 * @@ -587,8 +631,8 @@ function media_upload_form_handler() { $errors = null; if ( isset($_POST['send']) ) { - $keys = array_keys($_POST['send']); - $send_id = (int) array_shift($keys); + $keys = array_keys( $_POST['send'] ); + $send_id = (int) reset( $keys ); } if ( !empty($_POST['attachments']) ) foreach ( $_POST['attachments'] as $attachment_id => $attachment ) { @@ -618,8 +662,8 @@ function media_upload_form_handler() { * * @see wp_get_attachment_metadata() * - * @param WP_Post $post The WP_Post object. - * @param array $attachment An array of attachment metadata. + * @param array $post An array of post data. + * @param array $attachment An array of attachment metadata. */ $post = apply_filters( 'attachment_fields_to_save', $post, $attachment ); @@ -627,7 +671,8 @@ function media_upload_form_handler() { $image_alt = wp_unslash( $attachment['image_alt'] ); if ( $image_alt != get_post_meta($attachment_id, '_wp_attachment_image_alt', true) ) { $image_alt = wp_strip_all_tags( $image_alt, true ); - // update_meta expects slashed + + // Update_meta expects slashed. update_post_meta( $attachment_id, '_wp_attachment_image_alt', wp_slash( $image_alt ) ); } } @@ -648,10 +693,8 @@ function media_upload_form_handler() { if ( isset($_POST['insert-gallery']) || isset($_POST['update-gallery']) ) { ?> "; return $html; + } else { + return new WP_Error( 'image_sideload_failed' ); } } /** - * {@internal Missing Short Description}} + * Retrieves the legacy media uploader form in an iframe. * * @since 2.5.0 * - * @return unknown + * @return string|null */ function media_upload_gallery() { $errors = array(); @@ -860,11 +915,11 @@ function media_upload_gallery() { } /** - * {@internal Missing Short Description}} + * Retrieves the legacy media library form in an iframe. * * @since 2.5.0 * - * @return unknown + * @return string|null */ function media_upload_library() { $errors = array(); @@ -885,7 +940,7 @@ function media_upload_library() { * * @since 2.7.0 * - * @param object $post + * @param WP_Post $post * @param string $checked * @return string */ @@ -913,12 +968,11 @@ function image_align_input_fields( $post, $checked = '' ) { * * @since 2.7.0 * - * @param object $post + * @param WP_Post $post * @param bool|string $check * @return array */ function image_size_input_fields( $post, $check = '' ) { - /** * Filter the names and labels of the default image sizes. * @@ -934,45 +988,53 @@ function image_size_input_fields( $post, $check = '' ) { 'full' => __( 'Full Size' ) ) ); - if ( empty($check) ) - $check = get_user_setting('imgsize', 'medium'); - - foreach ( $size_names as $size => $label ) { - $downsize = image_downsize($post->ID, $size); - $checked = ''; - - // is this size selectable? - $enabled = ( $downsize[3] || 'full' == $size ); - $css_id = "image-size-{$size}-{$post->ID}"; - // if this size is the default but that's not available, don't select it - if ( $size == $check ) { - if ( $enabled ) - $checked = " checked='checked'"; - else - $check = ''; - } elseif ( !$check && $enabled && 'thumbnail' != $size ) { - // if $check is not enabled, default to the first available size that's bigger than a thumbnail - $check = $size; + if ( empty( $check ) ) { + $check = get_user_setting('imgsize', 'medium'); + } + $out = array(); + + foreach ( $size_names as $size => $label ) { + $downsize = image_downsize( $post->ID, $size ); + $checked = ''; + + // Is this size selectable? + $enabled = ( $downsize[3] || 'full' == $size ); + $css_id = "image-size-{$size}-{$post->ID}"; + + // If this size is the default but that's not available, don't select it. + if ( $size == $check ) { + if ( $enabled ) { $checked = " checked='checked'"; + } else { + $check = ''; } + } elseif ( ! $check && $enabled && 'thumbnail' != $size ) { + /* + * If $check is not enabled, default to the first available size + * that's bigger than a thumbnail. + */ + $check = $size; + $checked = " checked='checked'"; + } - $html = "
"; - - $html .= ""; - // only show the dimensions if that choice is available - if ( $enabled ) - $html .= " "; + $html = "
"; - $html .= '
'; + $html .= ""; - $out[] = $html; + // Only show the dimensions if that choice is available. + if ( $enabled ) { + $html .= " "; } + $html .= '
'; - return array( - 'label' => __('Size'), - 'input' => 'html', - 'html' => join("\n", $out), - ); + $out[] = $html; + } + + return array( + 'label' => __( 'Size' ), + 'input' => 'html', + 'html' => join( "\n", $out ), + ); } /** @@ -980,7 +1042,7 @@ function image_size_input_fields( $post, $check = '' ) { * * @since 2.7.0 * - * @param object $post + * @param WP_Post $post * @param string $url_type * @return string */ @@ -1006,15 +1068,23 @@ function image_link_input_fields($post, $url_type = '') { "; } +/** + * Output a textarea element for inputting an attachment caption. + * + * @since 3.4.0 + * + * @param WP_Post $edit_post Attachment WP_Post object. + * @return string HTML markup for the textarea element. + */ function wp_caption_input_textarea($edit_post) { - // post data is already escaped + // Post data is already escaped. $name = "attachments[{$edit_post->ID}][post_excerpt]"; return ''; } /** - * {@internal Missing Short Description}} + * Retrieves the image attachment fields to edit form fields. * * @since 2.5.0 * @@ -1027,13 +1097,13 @@ function image_attachment_fields_to_edit($form_fields, $post) { } /** - * {@internal Missing Short Description}} + * Retrieves the single non-image attachment fields to edit form fields. * * @since 2.5.0 * - * @param array $form_fields - * @param object $post {@internal $post not used}} - * @return array + * @param array $form_fields An array of attachment form fields. + * @param WP_Post $post The WP_Post attachment object. + * @return array Filtered attachment form fields. */ function media_single_attachment_fields_to_edit( $form_fields, $post ) { unset($form_fields['url'], $form_fields['align'], $form_fields['image-size']); @@ -1041,13 +1111,13 @@ function media_single_attachment_fields_to_edit( $form_fields, $post ) { } /** - * {@internal Missing Short Description}} + * Retrieves the post non-image attachment fields to edito form fields. * * @since 2.8.0 * - * @param array $form_fields - * @param object $post {@internal $post not used}} - * @return array + * @param array $form_fields An array of attachment form fields. + * @param WP_Post $post The WP_Post attachment object. + * @return array Filtered attachment form fields. */ function media_post_single_attachment_fields_to_edit( $form_fields, $post ) { unset($form_fields['image_url']); @@ -1063,9 +1133,9 @@ function media_post_single_attachment_fields_to_edit( $form_fields, $post ) { * * @since 2.5.0 * - * @param object $post - * @param array $attachment {@internal $attachment not used}} - * @return array + * @param array $post The WP_Post attachment object converted to an array. + * @param array $attachment An array of attachment metadata. + * @return array Filtered attachment post object. */ function image_attachment_fields_to_save( $post, $attachment ) { if ( substr( $post['post_mime_type'], 0, 5 ) == 'image' ) { @@ -1079,17 +1149,15 @@ function image_attachment_fields_to_save( $post, $attachment ) { return $post; } -add_filter( 'attachment_fields_to_save', 'image_attachment_fields_to_save', 10, 2 ); - /** - * {@internal Missing Short Description}} + * Retrieves the media element HTML to send to the editor. * * @since 2.5.0 * * @param string $html * @param integer $attachment_id * @param array $attachment - * @return array + * @return string */ function image_media_send_to_editor($html, $attachment_id, $attachment) { $post = get_post($attachment_id); @@ -1106,14 +1174,12 @@ function image_media_send_to_editor($html, $attachment_id, $attachment) { return $html; } -add_filter('media_send_to_editor', 'image_media_send_to_editor', 10, 3); - /** - * {@internal Missing Short Description}} + * Retrieves the attachment fields to edit form fields. * * @since 2.5.0 * - * @param object $post + * @param WP_Post $post * @param array $errors * @return array */ @@ -1185,7 +1251,7 @@ function get_attachment_fields_to_edit($post, $errors = null) { } // Merge default fields with their errors, so any key passed with the error (e.g. 'error', 'helps', 'value') will replace the default - // The recursive merge is easily traversed with array casting: foreach( (array) $things as $thing ) + // The recursive merge is easily traversed with array casting: foreach ( (array) $things as $thing ) $form_fields = array_merge_recursive($form_fields, (array) $errors); // This was formerly in image_attachment_fields_to_edit(). @@ -1236,6 +1302,8 @@ function get_attachment_fields_to_edit($post, $errors = null) { * * @since 2.5.0 * + * @global WP_Query $wp_the_query + * * @param int $post_id Optional. Post ID. * @param array $errors Errors for attachment, if any. * @return string @@ -1270,6 +1338,8 @@ function get_media_items( $post_id, $errors ) { * * @since 2.5.0 * + * @global string $redir_tab + * * @param int $attachment_id Attachment ID for modification. * @param string|array $args Optional. Override defaults. * @return string HTML form for attachment. @@ -1285,7 +1355,13 @@ function get_media_item( $attachment_id, $args = null ) { $post = get_post( $attachment_id ); $current_post_id = !empty( $_GET['post_id'] ) ? (int) $_GET['post_id'] : 0; - $default_args = array( 'errors' => null, 'send' => $current_post_id ? post_type_supports( get_post_type( $current_post_id ), 'editor' ) : true, 'delete' => true, 'toggle' => true, 'show_title' => true ); + $default_args = array( + 'errors' => null, + 'send' => $current_post_id ? post_type_supports( get_post_type( $current_post_id ), 'editor' ) : true, + 'delete' => true, + 'toggle' => true, + 'show_title' => true + ); $args = wp_parse_args( $args, $default_args ); /** @@ -1297,30 +1373,24 @@ function get_media_item( $attachment_id, $args = null ) { * * @param array $args An array of arguments. */ - $args = apply_filters( 'get_media_item_args', $args ); - extract( $args, EXTR_SKIP ); + $r = apply_filters( 'get_media_item_args', $args ); $toggle_on = __( 'Show' ); $toggle_off = __( 'Hide' ); - $filename = esc_html( wp_basename( $post->guid ) ); + $file = get_attached_file( $post->ID ); + $filename = esc_html( wp_basename( $file ) ); $title = esc_attr( $post->post_title ); - if ( $_tags = get_the_tags( $attachment_id ) ) { - foreach ( $_tags as $tag ) - $tags[] = $tag->name; - $tags = esc_attr( join( ', ', $tags ) ); - } - $post_mime_types = get_post_mime_types(); $keys = array_keys( wp_match_mime_types( array_keys( $post_mime_types ), $post->post_mime_type ) ); - $type = array_shift( $keys ); + $type = reset( $keys ); $type_html = ""; - $form_fields = get_attachment_fields_to_edit( $post, $errors ); + $form_fields = get_attachment_fields_to_edit( $post, $r['errors'] ); - if ( $toggle ) { - $class = empty( $errors ) ? 'startclosed' : 'startopen'; + if ( $r['toggle'] ) { + $class = empty( $r['errors'] ) ? 'startclosed' : 'startopen'; $toggle_links = " $toggle_on $toggle_off"; @@ -1330,7 +1400,7 @@ function get_media_item( $attachment_id, $args = null ) { } $display_title = ( !empty( $title ) ) ? $title : $filename; // $title shouldn't ever be empty, but just in case - $display_title = $show_title ? "
" . wp_html_excerpt( $display_title, 60, '…' ) . "
" : ''; + $display_title = $r['show_title'] ? "
" . wp_html_excerpt( $display_title, 60, '…' ) . "
" : ''; $gallery = ( ( isset( $_REQUEST['tab'] ) && 'gallery' == $_REQUEST['tab'] ) || ( isset( $redir_tab ) && 'gallery' == $redir_tab ) ); $order = ''; @@ -1404,14 +1474,19 @@ function get_media_item( $attachment_id, $args = null ) { 'extra_rows' => array(), ); - if ( $send ) - $send = get_submit_button( __( 'Insert into Post' ), 'button', "send[$attachment_id]", false ); + if ( $r['send'] ) { + $r['send'] = get_submit_button( __( 'Insert into Post' ), 'button', "send[$attachment_id]", false ); + } + + $delete = empty( $r['delete'] ) ? '' : $r['delete']; if ( $delete && current_user_can( 'delete_post', $attachment_id ) ) { if ( !EMPTY_TRASH_DAYS ) { $delete = "" . __( 'Delete Permanently' ) . ''; } elseif ( !MEDIA_TRASH ) { $delete = "" . __( 'Delete' ) . " -