Changeset 27356

Timestamp:

03/02/2014 08:47:31 PM (11 years ago)

Author:

DrewAPicture

Message:

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

Props nicolealleyinteractivecom, kpdesign.
Fixes #26957.

File:

• trunk/src/wp-admin/includes/class-wp-plugins-list-table.php (modified) (6 diffs)

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

@@ -41 +41 @@
         wp_reset_vars( array( 'orderby', 'order', 's' ) );
 
+        /**
+         * Filter the full array of plugins to list in the Plugins list table.
+         *
+         * @since 3.0.0
+         *
+         * @see get_plugins()
+         *
+         * @param array $plugins An array of plugins to display in the list table.
+         */
         $plugins = array(
             'all' => apply_filters( 'all_plugins', get_plugins() ),
@@ -55 +64 @@
 
         if ( ! is_multisite() || ( $screen->in_admin( 'network' ) && current_user_can( 'manage_network_plugins' ) ) ) {
-            if ( apply_filters( 'show_advanced_plugins', true, 'mustuse' ) )
+
+            /**
+             * Filter whether to display the advanced plugins list table.
+             *
+             * There are two types of advanced plugins - must-use and drop-ins -
+             * which can be used in a single site or Multisite network.
+             *
+             * The $type parameter allows you to differentiate between the type of advanced
+             * plugins to filter the display of. Contexts include 'mustuse' and 'dropins'.
+             *
+             * @since 3.0.0
+             *
+             * @param bool   $show Whether to show the advanced plugins for the specified
+             *                     plugin type. Default true.
+             * @param string $type The plugin type. Accepts 'mustuse', 'dropins'.
+             */
+            if ( apply_filters( 'show_advanced_plugins', true, 'mustuse' ) ) {
                 $plugins['mustuse'] = get_mu_plugins();
+            }
+
+            /** This action is documented in wp-admin/includes/class-wp-plugins-list-table.php */
             if ( apply_filters( 'show_advanced_plugins', true, 'dropins' ) )
                 $plugins['dropins'] = get_dropins();
@@ -370 +398 @@
 
         $prefix = $screen->in_admin( 'network' ) ? 'network_admin_' : '';
+
+        /**
+         * Filter the action links displayed for each plugin in the Plugins list table.
+         *
+         * The dynamic portion of the hook name, $prefix, refers to the context the
+         * action links are displayed in. The 'network_admin_' prefix is used if the
+         * current screen is the Network plugins list table. The prefix is empty ('')
+         * if the current screen is the site plugins list table.
+         *
+         * The default action links for the Network plugins list table include
+         * 'Network Activate', 'Network Deactivate', 'Edit', and 'Delete'.
+         *
+         * The default action links for the site plugins list table include
+         * 'Activate', 'Deactivate', and 'Edit', for a network site, and
+         * 'Activate', 'Deactivate', 'Edit', and 'Delete' for a single site.
+         *
+         * @since 2.5.0
+         *
+         * @param array  $actions     An array of plugin action links.
+         * @param string $plugin_file Path to the plugin file.
+         * @param array  $plugin_data An array of plugin data.
+         * @param string $context     The plugin context. Defaults are 'All', 'Active',
+         *                            'Inactive', 'Recently Activated', 'Upgrade',
+         *                            'Must-Use', 'Drop-ins', 'Search'.
+         */
         $actions = apply_filters( $prefix . 'plugin_action_links', array_filter( $actions ), $plugin_file, $plugin_data, $context );
+
+        /**
+         * Filter the list of action links displayed for a specific plugin.
+         *
+         * The first dynamic portion of the hook name, $prefix, refers to the context
+         * the action links are displayed in. The 'network_admin_' prefix is used if the
+         * current screen is the Network plugins list table. The prefix is empty ('')
+         * if the current screen is the site plugins list table.
+         *
+         * The second dynamic portion of the hook name, $plugin_file, refers to the path
+         * to the plugin file, relative to the plugins directory.
+         *
+         * @since 2.7.0
+         *
+         * @param array  $actions     An array of plugin action links.
+         * @param string $plugin_file Path to the plugin file.
+         * @param array  $plugin_data An array of plugin data.
+         * @param string $context     The plugin context. Defaults are 'All', 'Active',
+         *                            'Inactive', 'Recently Activated', 'Upgrade',
+         *                            'Must-Use', 'Drop-ins', 'Search'.
+         */
         $actions = apply_filters( $prefix . "plugin_action_links_$plugin_file", $actions, $plugin_file, $plugin_data, $context );
 
@@ -425 +499 @@
                         $plugin_meta[] = '<a href="' . $plugin_data['PluginURI'] . '" title="' . esc_attr__( 'Visit plugin site' ) . '">' . __( 'Visit plugin site' ) . '</a>';
 
+                    /**
+                     * Filter the array of row meta for each plugin in the Plugins list table.
+                     *
+                     * @since 2.8.0
+                     *
+                     * @param array  $plugin_meta An array of the plugin's metadata,
+                     *                            including the version, author,
+                     *                            author URI, and plugin URI.
+                     * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+                     * @param array  $plugin_data An array of plugin data.
+                     * @param string $status      Status of the plugin. Defaults are 'All', 'Active',
+                     *                            'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
+                     *                            'Drop-ins', 'Search'.
+                     */
                     $plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
                     echo implode( ' | ', $plugin_meta );
@@ -432 +520 @@
                 default:
                     echo "<td class='$column_name column-$column_name'$style>";
+
+                    /**
+                     * Fires inside each custom column of the Plugins list table.
+                     *
+                     * @since 3.1.0
+                     *
+                     * @param string $column_name Name of the column.
+                     * @param string $plugin_file Path to the plugin file.
+                     * @param array  $plugin_data An array of plugin data.
+                     */
                     do_action( 'manage_plugins_custom_column', $column_name, $plugin_file, $plugin_data );
                     echo "</td>";
@@ -439 +537 @@
         echo "</tr>";
 
+        /**
+         * Fires after each row in the Plugins list table.
+         *
+         * @since 2.3.0
+         *
+         * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+         * @param array  $plugin_data An array of plugin data.
+         * @param string $status      Status of the plugin. Defaults are 'All', 'Active',
+         *                            'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
+         *                            'Drop-ins', 'Search'.
+         */
         do_action( 'after_plugin_row', $plugin_file, $plugin_data, $status );
+
+        /**
+         * Fires after each specific row in the Plugins list table.
+         *
+         * The dynamic portion of the hook name, $plugin_file, refers to the path
+         * to the plugin file, relative to the plugins directory.
+         *
+         * @since 2.7.0
+         *
+         * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+         * @param array  $plugin_data An array of plugin data.
+         * @param string $status      Status of the plugin. Defaults are 'All', 'Active',
+         *                            'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
+         *                            'Drop-ins', 'Search'.
+         */
         do_action( "after_plugin_row_$plugin_file", $plugin_file, $plugin_data, $status );
     }