Changeset 51654

Timestamp:

08/24/2021 11:08:11 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify a comment in WP_Upgrader::run().

This matches the WP_Upgrader::download_package() documentation more closely.

Follow-up to [11005], [30758], [33685].

See #53399.

File:

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

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

@@ -379 +379 @@
      * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
      *
-     * @param string $remote_destination The location on the remote filesystem to be cleared
+     * @param string $remote_destination The location on the remote filesystem to be cleared.
      * @return bool|WP_Error True upon success, WP_Error on failure.
      */
@@ -564 +564 @@
              * @since 2.8.0
              *
-             * @param true|WP_Error $removed            Whether the destination was cleared. true upon success, WP_Error on failure.
+             * @param true|WP_Error $removed            Whether the destination was cleared.
+             *                                          True upon success, WP_Error on failure.
              * @param string        $local_destination  The local package destination.
              * @param string        $remote_destination The remote package destination.
@@ -737 +738 @@
 
         /*
-         * Download the package (Note, This just returns the filename
-         * of the file if the package is a local file)
+         * Download the package. Note: If the package is the full path
+         * to an existing local file, it will be returned untouched.
          */
         $download = $this->download_package( $options['package'], true, $options['hook_extra'] );
@@ -869 +870 @@
      * @since 2.8.0
      *
-     * @global WP_Filesystem_Base $wp_filesystem Subclass
+     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
      *
      * @param bool $enable True to enable maintenance mode, false to disable.