Changeset 26917

Timestamp:

01/08/2014 03:59:22 AM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/media-upload.php.

Props piontkowski for the initial patch.
Fixes #26075.

File:

• trunk/src/wp-admin/media-upload.php (modified) (3 diffs)

trunk/src/wp-admin/media-upload.php

@@ -39 +39 @@
 
     // 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
@@ -53 +62 @@
          * @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' );
@@ -61 +70 @@
 
     // 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" );
+    }