Changeset 42787 for trunk/src/wp-admin/includes/class-plugin-upgrader.php

Timestamp:

03/05/2018 09:49:53 PM (8 years ago)

Author:

johnbillion

Message:

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

See #42505

File:

• trunk/src/wp-admin/includes/class-plugin-upgrader.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-plugin-upgrader.php

@@ -136 +136 @@
          * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
          *
-         * @param string $plugin The basename path to the main plugin file.
+         * @param string $plugin Path to the plugin file relative to the plugins directory.
          * @param array  $args {
          *     Optional. Other arguments for upgrading a plugin package. Default empty array.
@@ -210 +210 @@
          * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
          *
-         * @param array $plugins Array of the basename paths of the plugins' main files.
-         * @param array $args {
-         *     Optional. Other arguments for upgrading several plugins at once. Default empty array.
-         *
-         *     @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
-         *                                    Default true.
+         * @param string[] $plugins Array of paths to plugin files relative to the plugins directory.
+         * @param array    $args {
+         *     Optional. Other arguments for upgrading several plugins at once.
+         *
+         *     @type bool $clear_update_cache Whether to clear the plugin updates cache if successful. Default true.
          * }
          * @return array|false An array of results indexed by plugin file, or false if unable to connect to the filesystem.