Changeset 25630

Timestamp:

09/26/2013 02:47:44 AM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/class-wp-plugin-install-list-table.php.

Props naomicbush.
Fixes #25357.

File:

• trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php (modified) (4 diffs)

trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php

@@ -38 +38 @@
         $nonmenu_tabs = array( 'plugin-information' ); //Valid actions to perform which do not have a Menu item.
 
+        /**
+         * Filter the tabs shown on the Plugin Install screen.
+         *
+         * @since 2.7.0
+         *
+         * @param array $tabs The tabs shown on the Plugin Install screen. Defaults are 'dashboard', 'search',
+         *                    'upload', 'featured', 'popular', 'new', and 'favorites'.
+         */
         $tabs = apply_filters( 'install_plugins_tabs', $tabs );
+
+        /**
+         * Filter tabs not associated with a menu item on the Plugin Install screen.
+         *
+         * @since 2.7.0
+         *
+         * @param array $nonmenu_tabs The tabs that don't have a Menu item on the Plugin Install screen.
+         */
         $nonmenu_tabs = apply_filters( 'install_plugins_nonmenu_tabs', $nonmenu_tabs );
 
@@ -89 +105 @@
         }
 
-        $args = apply_filters( 'install_plugins_table_api_args_' . $tab, $args );
+        /**
+         * Filter API request arguments for each Plugin Install screen tab.
+         *
+         * The dynamic portion of the hook name, $tab, refers to the plugin install tabs.
+         * Default tabs are 'dashboard', 'search', 'upload', 'featured', 'popular', 'new',
+         * and 'favorites'.
+         *
+         * @since 3.7.0
+         *
+         * @param array|bool $args Plugin Install API arguments.
+         */
+        $args = apply_filters( "install_plugins_table_api_args_$tab", $args );
 
         if ( !$args )
@@ -128 +155 @@
             <div class="tablenav top">
                 <div class="alignleft actions">
-                    <?php do_action( 'install_plugins_table_header' ); ?>
+                    <?php
+                    /**
+                     * Fires before the Plugin Install table header pagination is displayed.
+                     *
+                     * @since 2.7.0
+                     */
+                    do_action( 'install_plugins_table_header' ); ?>
                 </div>
                 <?php $this->pagination( $which ); ?>
@@ -222 +255 @@
             }
 
+            /**
+             * Filter the install action links for a plugin.
+             *
+             * @since 2.7.0
+             *
+             * @param array $action_links An array of plugin action hyperlinks. Defaults are links to Details and Install Now.
+             * @param array $plugin       The plugin currently being listed.
+             */
             $action_links = apply_filters( 'plugin_install_action_links', $action_links, $plugin );
         ?>