Make WordPress Core


Ignore:
Timestamp:
03/22/2018 08:26:06 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Document many more parameters and properties using typed array notation.

See #41756

File:
1 edited

Legend:

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

    r42787 r42871  
    671671             * @since 3.1.0
    672672             *
    673              * @param array $actions     An array of plugin action links. By default this can include 'activate',
    674              *                            'deactivate', and 'delete'.
    675              * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    676              * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
    677              * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
    678              *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
     673             * @param string[] $actions     An array of plugin action links. By default this can include 'activate',
     674             *                              'deactivate', and 'delete'.
     675             * @param string   $plugin_file Path to the plugin file relative to the plugins directory.
     676             * @param array    $plugin_data An array of plugin data. See `get_plugin_data()`.
     677             * @param string   $context     The plugin context. By default this can include 'all', 'active', 'inactive',
     678             *                              'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
    679679             */
    680680            $actions = apply_filters( 'network_admin_plugin_action_links', $actions, $plugin_file, $plugin_data, $context );
     
    688688             * @since 3.1.0
    689689             *
    690              * @param array $actions     An array of plugin action links. By default this can include 'activate',
    691              *                            'deactivate', and 'delete'.
    692              * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    693              * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
    694              * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
    695              *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
     690             * @param string[] $actions     An array of plugin action links. By default this can include 'activate',
     691             *                              'deactivate', and 'delete'.
     692             * @param string   $plugin_file Path to the plugin file relative to the plugins directory.
     693             * @param array    $plugin_data An array of plugin data. See `get_plugin_data()`.
     694             * @param string   $context     The plugin context. By default this can include 'all', 'active', 'inactive',
     695             *                              'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
    696696             */
    697697            $actions = apply_filters( "network_admin_plugin_action_links_{$plugin_file}", $actions, $plugin_file, $plugin_data, $context );
     
    706706             * @since 4.9.0 The 'Edit' link was removed from the list of action links.
    707707             *
    708              * @param array $actions     An array of plugin action links. By default this can include 'activate',
    709              *                            'deactivate', and 'delete'. With Multisite active this can also include
    710              *                            'network_active' and 'network_only' items.
    711              * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    712              * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
    713              * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
    714              *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
     708             * @param string[] $actions     An array of plugin action links. By default this can include 'activate',
     709             *                              'deactivate', and 'delete'. With Multisite active this can also include
     710             *                              'network_active' and 'network_only' items.
     711             * @param string   $plugin_file Path to the plugin file relative to the plugins directory.
     712             * @param array    $plugin_data An array of plugin data. See `get_plugin_data()`.
     713             * @param string   $context     The plugin context. By default this can include 'all', 'active', 'inactive',
     714             *                              'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
    715715             */
    716716            $actions = apply_filters( 'plugin_action_links', $actions, $plugin_file, $plugin_data, $context );
     
    725725             * @since 4.9.0 The 'Edit' link was removed from the list of action links.
    726726             *
    727              * @param array $actions     An array of plugin action links. By default this can include 'activate',
    728              *                            'deactivate', and 'delete'. With Multisite active this can also include
    729              *                            'network_active' and 'network_only' items.
    730              * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    731              * @param array  $plugin_data An array of plugin data. See `get_plugin_data()`.
    732              * @param string $context     The plugin context. By default this can include 'all', 'active', 'inactive',
    733              *                            'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
     727             * @param string[] $actions     An array of plugin action links. By default this can include 'activate',
     728             *                              'deactivate', and 'delete'. With Multisite active this can also include
     729             *                              'network_active' and 'network_only' items.
     730             * @param string   $plugin_file Path to the plugin file relative to the plugins directory.
     731             * @param array    $plugin_data An array of plugin data. See `get_plugin_data()`.
     732             * @param string   $context     The plugin context. By default this can include 'all', 'active', 'inactive',
     733             *                              'recently_activated', 'upgrade', 'mustuse', 'dropins', and 'search'.
    734734             */
    735735            $actions = apply_filters( "plugin_action_links_{$plugin_file}", $actions, $plugin_file, $plugin_data, $context );
     
    825825                     * @since 2.8.0
    826826                     *
    827                      * @param array $plugin_meta An array of the plugin's metadata,
    828                      *                            including the version, author,
    829                      *                            author URI, and plugin URI.
    830                      * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    831                      * @param array  $plugin_data An array of plugin data.
    832                      * @param string $status      Status of the plugin. Defaults are 'All', 'Active',
    833                      *                            'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
    834                      *                            'Drop-ins', 'Search'.
     827                     * @param string[] $plugin_meta An array of the plugin's metadata,
     828                     *                              including the version, author,
     829                     *                              author URI, and plugin URI.
     830                     * @param string   $plugin_file Path to the plugin file relative to the plugins directory.
     831                     * @param array    $plugin_data An array of plugin data.
     832                     * @param string   $status      Status of the plugin. Defaults are 'All', 'Active',
     833                     *                              'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
     834                     *                              'Drop-ins', 'Search'.
    835835                     */
    836836                    $plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
Note: See TracChangeset for help on using the changeset viewer.