Changeset 52986

Timestamp:

03/23/2022 06:02:27 PM (2 years ago)

Author:

davidbaumwald

Message:

Upgrade/Install: Fix the docs for the default value of $clear_working in WP_Upgrader::run.

The current docblock for WP_Upgrader::run indicates the default value for the clear_working key of the $options argument is false. However, in the code directly below, the default is shown to be `true. This change updates the docblock to correct the default.

This commit also reorders the $defaults to match the order they appear in the docblock.

Props paulkevan.
Fixes #55450.

File:

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

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

@@ -653 +653 @@
      *     @type bool   $clear_working               Whether to delete the files from the working
      *                                               directory after copying them to the destination.
-     *                                               Default false.
+     *                                               Default true.
      *     @type bool   $abort_if_destination_exists Whether to abort the installation if the destination
      *                                               folder already exists. When true, `$clear_destination`
@@ -673 +673 @@
             'destination'                 => '', // ...and this.
             'clear_destination'           => false,
+            'clear_working'               => true,
             'abort_if_destination_exists' => true, // Abort if the destination directory exists. Pass clear_destination as false please.
-            'clear_working'               => true,
             'is_multi'                    => false,
             'hook_extra'                  => array(), // Pass any extra $hook_extra args here, this will be passed to any hooked filters.