Ticket #26957: class-wp-plugins-list-table.2.diff

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

@@ -39 +39 @@
                 global $status, $plugins, $totals, $page, $orderby, $order, $s;
 
                 wp_reset_vars( array( 'orderby', 'order', 's' ) );
-
                 $plugins = array(
+                        /**
+                         * Filter the array of plugin files, which is the value of
+                         * the 'all' key in the parent array.
+                         *
+                         * @since 3.0.2
+                         *
+                         * @param array $plugins Array of plugins where key is the plugin file
+                         *                       path and the value is an array of the plugin data.
+                         */
                         'all' => apply_filters( 'all_plugins', get_plugins() ),
                         'search' => array(),
                         'active' => array(),
@@ -54 +62 @@
                 $screen = $this->screen;
 
                 if ( ! is_multisite() || ( $screen->in_admin( 'network' ) && current_user_can( 'manage_network_plugins' ) ) ) {
+                        /**
+                         * Filter whether to "show" advanced plugins.
+                         *
+                         * @since 3.0.2
+                         *
+                         * @param bool $show              Whether to show the advanced plugins for the specified
+                         *                                plugin type. Defaults to true.
+                         * @param string $plugin_type Must be one of 'mustuse' or '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();
 
@@ -362 +380 @@
                 } // end if $context
 
                 $prefix = $screen->in_admin( 'network' ) ? 'network_admin_' : '';
+                /**
+                 * Filter the list of default links.
+                 *
+                 * The dynamic portion of the hook name, $prefix, is either
+                 * 'network_admin_' if the current screen is in the network admin, or
+                 * '' if it is not.
+                 *
+                 * @since 3.0.3
+                 *
+                 * @param array $actions          Array of link code, each keyed by the corresponding action. Links are
+                 *                                keyed with 'deactivate', 'activate', 'edit', and 'delete'.
+                 * @param string $plugin_file Path to the plugin file.
+                 * @param array $plugin_data  Array of plugin data.
+                 * @param string $context     The plugin context, one of 'active', 'inactive', 'recently_activated',
+                 *                            'upgrade', 'mustuse', 'dropins', 'search', or 'all'.
+                 */
                 $actions = apply_filters( $prefix . 'plugin_action_links', array_filter( $actions ), $plugin_file, $plugin_data, $context );
+                /**
+                 * Filter the list of action links for the specified plugin.
+                 *
+                 * The dynamic portion of the hook name, $prefix, is either 'network_admin_'
+                 * if the current screen is in the network admin, or '' if it is not.
+                 * The dynamic portion of the hook name, $plugin_file, is the path to
+                 * the plugin file, relative to the plugins directory.
+                 *
+                 * @since 3.0.3
+                 *
+                 * @param array $actions          Array of link code, each keyed by the corresponding action. Links are
+                 *                                keyed with 'deactivate', 'activate', 'edit', and 'delete'.
+                 * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+                 * @param array $plugin_data  Array of plugin data.
+                 * @param string $context     The plugin context, one of 'active', 'inactive', 'recently_activated',
+                 *                            'upgrade', 'mustuse', 'dropins', 'search', or 'all'.
+                 */
                 $actions = apply_filters( $prefix . "plugin_action_links_$plugin_file", $actions, $plugin_file, $plugin_data, $context );
 
                 $class = $is_active ? 'active' : 'inactive';
@@ -416 +467 @@
                                         }
                                         if ( ! empty( $plugin_data['PluginURI'] ) )
                                                 $plugin_meta[] = '<a href="' . $plugin_data['PluginURI'] . '" title="' . esc_attr__( 'Visit plugin site' ) . '">' . __( 'Visit plugin site' ) . '</a>';
-
+                                        /**
+                                         * Filter the plugin meta for the row.
+                                         *
+                                         * @since 3.0.2
+                                         *
+                                         * @param array $plugin_meta  Array of plugin meta data.
+                                         * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+                                         * @param array $plugin_data  Array of plugin data.
+                                         * @param string $status      The plugin status, one of 'active', 'inactive', 'recently_activated',
+                                         *                            'upgrade', 'mustuse', 'dropins', 'search', or 'all'.
+                                         */
                                         $plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
                                         echo implode( ' | ', $plugin_meta );
 
@@ -424 +485 @@
                                         break;
                                 default:
                                         echo "<td class='$column_name column-$column_name'$style>";
+                                        /**
+                                         * Fires inside the td tag of the custom column.
+                                         *
+                                         * @since 3.0.2
+                                         *
+                                         * @param string $column_name The column name.
+                                         * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+                                         * @param array  $plugin_data Array of plugin data.
+                                         */
                                         do_action( 'manage_plugins_custom_column', $column_name, $plugin_file, $plugin_data );
                                         echo "</td>";
                         }
@@ -431 +501 @@
 
                 echo "</tr>";
 
+                /**
+                 * Fires after the tr tag of the plugin row.
+                 *
+                 * @since 3.0.2
+                 *
+                 * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+                 * @param array  $plugin_data Array of plugin data.
+                 * @param string $status      The plugin status, one of 'active', 'inactive', 'recently_activated',
+                 *                            'upgrade', 'mustuse', 'dropins', 'search', or 'all'.
+                 */
                 do_action( 'after_plugin_row', $plugin_file, $plugin_data, $status );
+                /**
+                 * Fires after the tr tag of the plugin row of the specified plugin.
+                 *
+                 * The dynamic portion of the hook name, $plugin_file, is the path to the plugin file,
+                 * relative to the plugins directory.
+                 *
+                 * @since 3.0.2
+                 *
+                 * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+                 * @param array  $plugin_data Array of plugin data
+                 * @param string $status      The plugin status, one of 'active', 'inactive', 'recently_activated',
+                 *                            'upgrade', 'mustuse', 'dropins', 'search', or 'all'.
+                 */
                 do_action( "after_plugin_row_$plugin_file", $plugin_file, $plugin_data, $status );
         }
 }