WordPress.org

Make WordPress Core


Ignore:
Timestamp:
03/05/2018 09:49:53 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Standardise and correct documentation relating to parameters which accept plugin names.

See #42505

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-plugin-upgrader.php

    r42786 r42787  
    136136     * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
    137137     *
    138      * @param string $plugin The basename path to the main plugin file.
     138     * @param string $plugin Path to the plugin file relative to the plugins directory.
    139139     * @param array  $args {
    140140     *     Optional. Other arguments for upgrading a plugin package. Default empty array.
     
    210210     * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
    211211     *
    212      * @param array $plugins Array of the basename paths of the plugins' main files.
    213      * @param array $args {
    214      *     Optional. Other arguments for upgrading several plugins at once. Default empty array.
    215      *
    216      *     @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
    217      *                                    Default true.
     212     * @param string[] $plugins Array of paths to plugin files relative to the plugins directory.
     213     * @param array    $args {
     214     *     Optional. Other arguments for upgrading several plugins at once.
     215     *
     216     *     @type bool $clear_update_cache Whether to clear the plugin updates cache if successful. Default true.
    218217     * }
    219218     * @return array|false An array of results indexed by plugin file, or false if unable to connect to the filesystem.
Note: See TracChangeset for help on using the changeset viewer.