Index: src/wp-admin/includes/media.php =================================================================== --- src/wp-admin/includes/media.php (revision 25562) +++ src/wp-admin/includes/media.php (working copy) @@ -21,7 +21,14 @@ 'library' => __('Media Library') ); - return apply_filters('media_upload_tabs', $_default_tabs); + /** + * Filter the available tabs in the legacy (pre-3.5) media popup. + * + * @since 2.5.0 + * + * @param array $_default_tabs An array of media tabs in the form of key/value pairs. + */ + return apply_filters( 'media_upload_tabs', $_default_tabs ); } /** @@ -73,7 +80,12 @@ elseif ( isset($_GET['tab']) && array_key_exists($_GET['tab'], $tabs) ) $current = $_GET['tab']; else - $current = apply_filters('media_upload_default_tab', $default); + /** + * Filter the default tab in the legacy (pre-3.5) media popup. + * + * @since 2.5.0 + */ + $current = apply_filters( 'media_upload_default_tab', $default ); foreach ( $tabs as $callback => $text ) { $class = ''; @@ -113,6 +125,20 @@ if ( $url ) $html = '$html"; + /** + * Filter the image HTML markup to send to the editor. + * + * @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. + */ $html = apply_filters( 'image_send_to_editor', $html, $id, $caption, $title, $align, $url, $size, $alt ); return $html; @@ -135,6 +161,16 @@ */ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $alt = '' ) { + /** + * Filter whether to disable captions. + * + * Prevents image captions from being appended to image HTML when inserted into the editor. + * + * @since 2.7.0 + * + * @param bool Whether to disable appending captions. Returning true to the filter will disable captions. + * Default empty string. + */ if ( empty($caption) || apply_filters( 'disable_captions', '' ) ) return $html; @@ -156,6 +192,14 @@ $shcode = '[caption id="' . $id . '" align="align' . $align . '" width="' . $width . '"]' . $html . ' ' . $caption . '[/caption]'; + /** + * Filter the image HTML markup including the caption shortcode. + * + * @since 2.6.0 + * + * @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 ); } add_filter( 'image_send_to_editor', 'image_add_caption', 20, 8 ); @@ -397,16 +441,73 @@ //]]> class="wp-core-ui no-js"> @@ -418,6 +519,11 @@ $args = array_slice($args, 1); call_user_func_array($content_func, $args); + /** + * Prints scripts enqueued for the admin footer. + * + * @since 2.8.0 + */ do_action('admin_print_footer_scripts'); ?> @@ -446,7 +552,16 @@ echo '' . $img . __( 'Add Media' ) . ''; - // Don't use this filter. Want to add a button? Use the media_buttons action. + /** + * Filter legacy media buttons (deprecated). + * + * Don't use this filter. Want to add a button? Use the 'media_buttons' action. + * + * @since 2.5.0 + * @deprecated 3.5.0 + * + * @param string Media buttons context. + */ $legacy_filter = apply_filters('media_buttons_context', ''); // deprecated if ( $legacy_filter ) { @@ -472,6 +587,15 @@ if ( ! empty( $tab ) ) $upload_iframe_src = add_query_arg('tab', $tab, $upload_iframe_src); + /** + * Filter the upload iframe source URL by media type. + * + * The dynamic portion of the hook name, $type, refers to the type of media uploaded. + * + * @since 3.0.0 + * + * @param string $upload_iframe_src The upload iframe source URL by type. + */ $upload_iframe_src = apply_filters($type . '_upload_iframe_src', $upload_iframe_src); return add_query_arg('TB_iframe', true, $upload_iframe_src); @@ -514,6 +638,14 @@ $post['post_parent'] = $attachment['post_parent']; } + /** + * Filter attachment fields to be saved. + * + * @since 2.5.0 + * + * @param WP_Post $post The WP_Post object. + * @param array $attachment An array of attachment metadata. + */ $post = apply_filters('attachment_fields_to_save', $post, $attachment); if ( isset($attachment['image_alt']) ) { @@ -561,6 +693,15 @@ $html = "$html"; } + /** + * Filter the media HTML markup sent to the editor. + * + * @since 2.5.0 + * + * @param string $html The media's HTML markup sent to the editor. + * @param int $send_id The first key from the $_POST['send'] data. + * @param array $attachment The attachment metadata. + */ $html = apply_filters('media_send_to_editor', $html, $send_id, $attachment); return media_send_to_editor($html); } @@ -608,6 +749,17 @@ && ( 'audio' == $ext_type || 'video' == $ext_type ) ) $type = $ext_type; + /** + * Filter the media URL sent to the editor by type. + * + * The dynamic portion of the hook name, $type, refers to the type of media being sent. + * + * @since 3.3.0 + * + * @param string $html The HTML markup sent to the editor. + * @param string $src The media source URL. + * @param string $title The media title. + */ $html = apply_filters( $type . '_send_to_editor_url', $html, esc_url_raw( $src ), $title ); } else { $align = ''; @@ -779,8 +931,22 @@ function image_size_input_fields( $post, $check = '' ) { // get a list of the actual pixel dimensions of each possible intermediate version of this image - $size_names = apply_filters( 'image_size_names_choose', array('thumbnail' => __('Thumbnail'), 'medium' => __('Medium'), 'large' => __('Large'), 'full' => __('Full Size')) ); + $size_names = array( + 'thumbnail' => __( 'Thumbnail' ), + 'medium' => __( 'Medium' ), + 'large' => __( 'Large' ), + 'full' => __( 'Full Size' ) + ); + /** + * Filter the names of the default image sizes. + * + * @since 3.3.0 + * + * @param array $size_names An array of image sizes and their names. + */ + $size_names = apply_filters( 'image_size_names_choose', $size_names ); + if ( empty($check) ) $check = get_user_setting('imgsize', 'medium'); @@ -1061,6 +1227,14 @@ unset( $form_fields['image_alt'] ); } + /** + * Filter the attachment fields to edit. + * + * @since 2.5.0 + * + * @param array $form_fields An array of attachment form fields. + * @param WP_Post $post The WP_Post attachment object. + */ $form_fields = apply_filters('attachment_fields_to_edit', $form_fields, $post); return $form_fields; @@ -1126,6 +1300,14 @@ $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 ); + + /** + * Filter the arguments used to get an image for the edit image form. + * + * @since 3.1.0 + * + * @param array $args An array of arguments. @see get_media_item() + */ $args = apply_filters( 'get_media_item_args', $args ); extract( $args, EXTR_SKIP ); @@ -1180,6 +1362,15 @@ $meta = wp_get_attachment_metadata( $post->ID ); if ( isset( $meta['width'], $meta['height'] ) ) $media_dims .= "{$meta['width']} × {$meta['height']} "; + + /** + * Filter the media metadata. + * + * @since 2.5.0 + * + * @param string $media_dims The HTML markup containing the media dimensions. + * @param WP_Post $post The WP_Post attachment object. + */ $media_dims = apply_filters( 'media_meta', $media_dims, $post ); $image_edit_button = ''; @@ -1343,6 +1534,8 @@ $user_can_edit = current_user_can( 'edit_post', $attachment_id ); $args = wp_parse_args( $args, $default_args ); + + //duplicate_hook $args = apply_filters( 'get_media_item_args', $args ); $form_fields = array(); @@ -1376,6 +1569,7 @@ // The recursive merge is easily traversed with array casting: foreach( (array) $things as $thing ) $form_fields = array_merge_recursive($form_fields, (array) $args['errors'] ); + //duplicate_hook $form_fields = apply_filters( 'attachment_fields_to_edit', $form_fields, $post ); unset( $form_fields['image-size'], $form_fields['align'], $form_fields['image_alt'], @@ -1382,6 +1576,7 @@ $form_fields['post_title'], $form_fields['post_excerpt'], $form_fields['post_content'], $form_fields['url'], $form_fields['menu_order'], $form_fields['image_url'] ); + //duplicate_hook $media_meta = apply_filters( 'media_meta', '', $post ); $defaults = array( @@ -1545,7 +1740,12 @@ return; } -do_action('pre-upload-ui'); +/** + * Fires just before the legacy (pre-3.5) upload interface is loaded. + * + * @since 2.6.0 + */ +do_action( 'pre-upload-ui' ); $post_params = array( "post_id" => $post_id, @@ -1555,7 +1755,17 @@ "short" => "1", ); -$post_params = apply_filters( 'upload_post_params', $post_params ); // hook change! old name: 'swfupload_post_params' +/** + * Filter the media upload post parameters. + * + * Previously 'swfupload_post_params'. + * + * @since 3.3.0 + * @since 3.5.0 + * + * @param array $post_params An array of media upload parameters used by Plupload. + */ +$post_params = apply_filters( 'upload_post_params', $post_params ); $plupload_init = array( 'runtimes' => 'html5,silverlight,flash,html4', @@ -1579,6 +1789,13 @@ if ( wp_is_mobile() ) $plupload_init['multi_selection'] = false; +/** + * Filter the default Plupload settings. + * + * @since 3.3.0 + * + * @param array $plupload_init An array of default settings used by Plupload. + */ $plupload_init = apply_filters( 'plupload_init', $plupload_init ); ?> @@ -1598,7 +1815,16 @@
- +

@@ -1606,11 +1832,27 @@

- +
- +

@@ -1618,7 +1860,14 @@

- +
@@ -1627,7 +1876,15 @@ /g, '>'); - + if ( f.caption.value ) { caption = f.caption.value.replace(/\r\n|\r/g, '\n'); caption = caption.replace(/<[a-zA-Z0-9]+( [^<>]+)?>/g, function(a){ @@ -1818,7 +2088,17 @@
- +
@@ -1840,6 +2120,7 @@ $post_id = intval($_REQUEST['post_id']); $form_action_url = admin_url("media-upload.php?type=$type&tab=gallery&post_id=$post_id"); + //duplicate_hook $form_action_url = apply_filters('media_upload_form_url', $form_action_url, $type); $form_class = 'media-upload-form validate'; @@ -1986,6 +2267,7 @@ $post_id = isset( $_REQUEST['post_id'] ) ? intval( $_REQUEST['post_id'] ) : 0; $form_action_url = admin_url("media-upload.php?type=$type&tab=library&post_id=$post_id"); + //duplicate_hook $form_action_url = apply_filters('media_upload_form_url', $form_action_url, $type); $form_class = 'media-upload-form validate'; @@ -2049,6 +2331,13 @@ $type_links[] = "
  • $mime_type, 'paged'=>false))) . "'$class>" . sprintf( translate_nooped_plural( $label[2], $num_posts[$mime_type] ), "" . number_format_i18n( $num_posts[$mime_type] ) . '') . ''; } +/** + * Filter the media upload mime type list items. + * + * @since 3.1.0 + * + * @param array $type_links An array of list items containing mime type link HTML. + */ echo implode(' |
    • ', apply_filters( 'media_upload_mime_type_links', $type_links ) ) . ''; unset($type_links); ?> @@ -2148,6 +2437,7 @@ * @return string the form html */ function wp_media_insert_url_form( $default_view = 'image' ) { + //duplicate_hook if ( !apply_filters( 'disable_captions', '' ) ) { $caption = ' @@ -2430,6 +2720,7 @@ $meta = wp_get_attachment_metadata( $post->ID ); if ( isset( $meta['width'], $meta['height'] ) ) $media_dims .= "{$meta['width']} × {$meta['height']} "; + //duplicate_hook $media_dims = apply_filters( 'media_meta', $media_dims, $post ); $att_url = wp_get_attachment_url( $post->ID );