From b3b3316102f6256acea58c7c3b6e44f0b066e94d Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Wed, 8 Jan 2014 04:00:11 +0000 Subject: [PATCH] Inline documentation for hooks in wp-admin/media-upload.php. Props piontkowski for the initial patch. Fixes #26075. Built from https://develop.svn.wordpress.org/trunk@26917 git-svn-id: http://core.svn.wordpress.org/trunk@26798 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/media-upload.php | 50 ++++++++++++++++++++++++++++++++------- 1 file changed, 42 insertions(+), 8 deletions(-) diff --git a/wp-admin/media-upload.php b/wp-admin/media-upload.php index f26ffd91eb..9a6e8f90e4 100644 --- a/wp-admin/media-upload.php +++ b/wp-admin/media-upload.php @@ -38,10 +38,19 @@ if ( isset($action) && $action == 'edit' && !$ID ) wp_die( __( 'Cheatin’ uh?' ) ); // upload type: image, video, file, ..? - if ( isset($_GET['type']) ) + if ( isset($_GET['type']) ) { $type = strval($_GET['type']); - else - $type = apply_filters('media_upload_default_type', 'file'); + } else { + /** + * Filter the default media upload type in the legacy (pre-3.5.0) media popup. + * + * @since 2.5.0 + * + * @param string $type The default media upload type. Possible values include + * 'image', 'audio', 'video', 'file', etc. Default 'file'. + */ + $type = apply_filters( 'media_upload_default_type', 'file' ); + } // tab: gallery, library, or type-specific if ( isset($_GET['tab']) ) { @@ -52,7 +61,7 @@ if ( isset($action) && $action == 'edit' && !$ID ) * * @since 2.5.0 * - * @param string $type The default media popup tab. + * @param string $type The default media popup tab. Default 'type' (From Computer). */ $tab = apply_filters( 'media_upload_default_tab', 'type' ); } @@ -60,7 +69,32 @@ if ( isset($action) && $action == 'edit' && !$ID ) $body_id = 'media-upload'; // let the action code decide how to handle the request - if ( $tab == 'type' || $tab == 'type_url' || ! array_key_exists( $tab , media_upload_tabs() ) ) - do_action("media_upload_$type"); - else - do_action("media_upload_$tab"); + if ( $tab == 'type' || $tab == 'type_url' || ! array_key_exists( $tab , media_upload_tabs() ) ) { + /** + * Fires inside specific upload-type views in the legacy (pre-3.5.0) + * media popup based on the current tab. + * + * The dynamic portion of the hook name, $type, refers to the specific + * media upload type. Possible values include 'image', 'audio', 'video', + * 'file', etc. + * + * The hook only fires if the current $tab is 'type' (From Computer), + * 'type_url' (From URL), or, if the tab does not exist (i.e., has not + * been registered via the 'media_upload_tabs' filter. + * + * @since 2.5.0 + */ + do_action( "media_upload_$type" ); + } else { + /** + * Fires inside limited and specific upload-tab views in the legacy + * (pre-3.5.0) media popup. + * + * The dynamic portion of the hook name, $tab, refers to the specific + * media upload tab. Possible values include 'library' (Media Library), + * or any custom tab registered via the 'media_upload_tabs' filter. + * + * @since 2.5.0 + */ + do_action( "media_upload_$tab" ); + }