WordPress.org

Make WordPress Core

Changeset 41231


Ignore:
Timestamp:
08/04/2017 10:14:37 PM (2 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

    r41161 r41231  
    644644             * Filters the action links displayed for each plugin in the Network Admin Plugins list table.
    645645             *
    646              * The default action links for the Network plugins list table include
    647              * 'Network Activate', 'Network Deactivate', and 'Delete'.
    648              *
    649646             * @since 3.1.0
    650647             *
    651              * @param array  $actions     An array of plugin action links.
     648             * @param array  $actions     An array of plugin action links. By default this can include 'activate',
     649             *                            'deactivate', and 'delete'.
    652650             * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    653              * @param array  $plugin_data An array of plugin data.
    654              * @param string $context     The plugin context. Defaults are 'All', 'Active',
    655              *                            'Inactive', 'Recently Activated', 'Upgrade',
    656              *                            'Must-Use', 'Drop-ins', 'Search'.
     651             * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
     652             * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
     653             *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
    657654             */
    658655            $actions = apply_filters( 'network_admin_plugin_action_links', $actions, $plugin_file, $plugin_data, $context );
     
    661658             * Filters the list of action links displayed for a specific plugin in the Network Admin Plugins list table.
    662659             *
    663              * The dynamic portion of the hook name, $plugin_file, refers to the path
     660             * The dynamic portion of the hook name, `$plugin_file`, refers to the path
    664661             * to the plugin file, relative to the plugins directory.
    665662             *
    666663             * @since 3.1.0
    667664             *
    668              * @param array  $actions     An array of plugin action links.
     665             * @param array  $actions     An array of plugin action links. By default this can include 'activate',
     666             *                            'deactivate', and 'delete'.
    669667             * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    670              * @param array  $plugin_data An array of plugin data.
    671              * @param string $context     The plugin context. Defaults are 'All', 'Active',
    672              *                            'Inactive', 'Recently Activated', 'Upgrade',
    673              *                            'Must-Use', 'Drop-ins', 'Search'.
     668             * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
     669             * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
     670             *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
    674671             */
    675672            $actions = apply_filters( "network_admin_plugin_action_links_{$plugin_file}", $actions, $plugin_file, $plugin_data, $context );
     
    680677             * Filters the action links displayed for each plugin in the Plugins list table.
    681678             *
    682              * The default action links for the site plugins list table include
    683              * 'Activate', and 'Deactivate', for a network site, and
    684              * 'Activate', 'Deactivate', and 'Delete' for a single site.
    685              *
    686679             * @since 2.5.0
    687680             * @since 2.6.0 The `$context` parameter was added.
    688              *
    689              * @param array  $actions     An array of plugin action links.
     681             * @since 4.9.0 The 'Edit' link was removed from the list of action links.
     682             *
     683             * @param array  $actions     An array of plugin action links. By default this can include 'activate',
     684             *                            'deactivate', and 'delete'. With Multisite active this can also include
     685             *                            'network_active' and 'network_only' items.
    690686             * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    691              * @param array  $plugin_data An array of plugin data.
    692              * @param string $context     The plugin context. Defaults are 'All', 'Active',
    693              *                            'Inactive', 'Recently Activated', 'Upgrade',
    694              *                            'Must-Use', 'Drop-ins', 'Search'.
     687             * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
     688             * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
     689             *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
    695690             */
    696691            $actions = apply_filters( 'plugin_action_links', $actions, $plugin_file, $plugin_data, $context );
     
    699694             * Filters the list of action links displayed for a specific plugin in the Plugins list table.
    700695             *
    701              * The dynamic portion of the hook name, $plugin_file, refers to the path
     696             * The dynamic portion of the hook name, `$plugin_file`, refers to the path
    702697             * to the plugin file, relative to the plugins directory.
    703698             *
    704699             * @since 2.7.0
    705              *
    706              * @param array  $actions     An array of plugin action links.
     700             * @since 4.9.0 The 'Edit' link was removed from the list of action links.
     701             *
     702             * @param array  $actions     An array of plugin action links. By default this can include 'activate',
     703             *                            'deactivate', and 'delete'. With Multisite active this can also include
     704             *                            'network_active' and 'network_only' items.
    707705             * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    708              * @param array  $plugin_data An array of plugin data.
    709              * @param string $context     The plugin context. Defaults are 'All', 'Active',
    710              *                            'Inactive', 'Recently Activated', 'Upgrade',
    711              *                            'Must-Use', 'Drop-ins', 'Search'.
     706             * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
     707             * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
     708             *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
    712709             */
    713710            $actions = apply_filters( "plugin_action_links_{$plugin_file}", $actions, $plugin_file, $plugin_data, $context );
Note: See TracChangeset for help on using the changeset viewer.