Changeset 41231

Timestamp:

08/04/2017 10:14:37 PM (8 years ago)

Author:

johnbillion

Message:

Plugins: Correct and improve docblocks for the various plugin_action_links filters on the Plugins screen.

This also adds a changelog for the removal of the Edit links in [41160].

See #41017
Fixes #38169

File:

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

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

@@ -644 +644 @@
              * Filters the action links displayed for each plugin in the Network Admin Plugins list table.
              *
-             * The default action links for the Network plugins list table include
-             * 'Network Activate', 'Network Deactivate', and 'Delete'.
-             *
              * @since 3.1.0
              *
-             * @param array  $actions     An array of plugin action links.
+             * @param array  $actions     An array of plugin action links. By default this can include 'activate',
+             *                            'deactivate', and 'delete'.
              * @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 $context     The plugin context. Defaults are 'All', 'Active',
-             *                            'Inactive', 'Recently Activated', 'Upgrade',
-             *                            'Must-Use', 'Drop-ins', 'Search'.
+             * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
+             * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
+             *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
              */
             $actions = apply_filters( 'network_admin_plugin_action_links', $actions, $plugin_file, $plugin_data, $context );
@@ -661 +658 @@
              * Filters the list of action links displayed for a specific plugin in the Network Admin Plugins list table.
              *
-             * The dynamic portion of the hook name, $plugin_file, refers to the path
+             * The dynamic portion of the hook name, `$plugin_file`, refers to the path
              * to the plugin file, relative to the plugins directory.
              *
              * @since 3.1.0
              *
-             * @param array  $actions     An array of plugin action links.
+             * @param array  $actions     An array of plugin action links. By default this can include 'activate',
+             *                            'deactivate', and 'delete'.
              * @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 $context     The plugin context. Defaults are 'All', 'Active',
-             *                            'Inactive', 'Recently Activated', 'Upgrade',
-             *                            'Must-Use', 'Drop-ins', 'Search'.
+             * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
+             * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
+             *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
              */
             $actions = apply_filters( "network_admin_plugin_action_links_{$plugin_file}", $actions, $plugin_file, $plugin_data, $context );
@@ -680 +677 @@
              * Filters the action links displayed for each plugin in the Plugins list table.
              *
-             * The default action links for the site plugins list table include
-             * 'Activate', and 'Deactivate', for a network site, and
-             * 'Activate', 'Deactivate', and 'Delete' for a single site.
-             *
              * @since 2.5.0
              * @since 2.6.0 The `$context` parameter was added.
-             *
-             * @param array  $actions     An array of plugin action links.
+             * @since 4.9.0 The 'Edit' link was removed from the list of action links.
+             *
+             * @param array  $actions     An array of plugin action links. By default this can include 'activate',
+             *                            'deactivate', and 'delete'. With Multisite active this can also include
+             *                            'network_active' and 'network_only' items.
              * @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 $context     The plugin context. Defaults are 'All', 'Active',
-             *                            'Inactive', 'Recently Activated', 'Upgrade',
-             *                            'Must-Use', 'Drop-ins', 'Search'.
+             * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
+             * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
+             *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
              */
             $actions = apply_filters( 'plugin_action_links', $actions, $plugin_file, $plugin_data, $context );
@@ -699 +694 @@
              * Filters the list of action links displayed for a specific plugin in the Plugins list table.
              *
-             * The dynamic portion of the hook name, $plugin_file, refers to the path
+             * 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 array  $actions     An array of plugin action links.
+             * @since 4.9.0 The 'Edit' link was removed from the list of action links.
+             *
+             * @param array  $actions     An array of plugin action links. By default this can include 'activate',
+             *                            'deactivate', and 'delete'. With Multisite active this can also include
+             *                            'network_active' and 'network_only' items.
              * @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 $context     The plugin context. Defaults are 'All', 'Active',
-             *                            'Inactive', 'Recently Activated', 'Upgrade',
-             *                            'Must-Use', 'Drop-ins', 'Search'.
+             * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
+             * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
+             *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
              */
             $actions = apply_filters( "plugin_action_links_{$plugin_file}", $actions, $plugin_file, $plugin_data, $context );