--- a/wp/wp-admin/includes/class-wp-upgrader.php Wed Sep 21 18:19:35 2022 +0200
+++ b/wp/wp-admin/includes/class-wp-upgrader.php Tue Sep 27 16:37:53 2022 +0200
@@ -162,7 +162,7 @@
$this->strings['folder_exists'] = __( 'Destination folder already exists.' );
$this->strings['mkdir_failed'] = __( 'Could not create directory.' );
$this->strings['incompatible_archive'] = __( 'The package could not be installed.' );
- $this->strings['files_not_writable'] = __( 'The update cannot be installed because we will be unable to copy some files. This is usually due to inconsistent file permissions.' );
+ $this->strings['files_not_writable'] = __( 'The update cannot be installed because some files could not be copied. This is usually due to inconsistent file permissions.' );
$this->strings['maintenance_start'] = __( 'Enabling Maintenance mode…' );
$this->strings['maintenance_end'] = __( 'Disabling Maintenance mode…' );
@@ -244,6 +244,7 @@
* Download a package.
*
* @since 2.8.0
+ * @since 5.2.0 Added the `$check_signatures` parameter.
* @since 5.5.0 Added the `$hook_extra` parameter.
*
* @param string $package The URI of the package. If this is the full path to an
@@ -378,8 +379,8 @@
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
- * @param string $remote_destination The location on the remote filesystem to be cleared
- * @return bool|WP_Error True upon success, WP_Error on failure.
+ * @param string $remote_destination The location on the remote filesystem to be cleared.
+ * @return true|WP_Error True upon success, WP_Error on failure.
*/
public function clear_destination( $remote_destination ) {
global $wp_filesystem;
@@ -422,7 +423,7 @@
/**
* Install a package.
*
- * Copies the contents of a package form a source directory, and installs them in
+ * Copies the contents of a package from a source directory, and installs them in
* a destination directory. Optionally removes the source. It can also optionally
* clear out the destination folder if it already exists.
*
@@ -439,8 +440,8 @@
* Default empty.
* @type bool $clear_destination Whether to delete any files already in the destination
* folder. Default false.
- * @type bool $clear_working Whether to delete the files form the working directory
- * after copying to the destination. Default false.
+ * @type bool $clear_working Whether to delete the files from the working directory
+ * after copying them to the destination. Default false.
* @type bool $abort_if_destination_exists Whether to abort the installation if
* the destination folder already exists. Default true.
* @type array $hook_extra Extra arguments to pass to the filter hooks called by
@@ -476,15 +477,14 @@
$this->skin->feedback( 'installing_package' );
/**
- * Filters the install response before the installation has started.
+ * Filters the installation response before the installation has started.
*
- * Returning a truthy value, or one that could be evaluated as a WP_Error
- * will effectively short-circuit the installation, returning that value
- * instead.
+ * Returning a value that could be evaluated as a `WP_Error` will effectively
+ * short-circuit the installation, returning that value instead.
*
* @since 2.8.0
*
- * @param bool|WP_Error $response Response.
+ * @param bool|WP_Error $response Installation response.
* @param array $hook_extra Extra arguments passed to hooked filters.
*/
$res = apply_filters( 'upgrader_pre_install', true, $args['hook_extra'] );
@@ -564,7 +564,8 @@
*
* @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.
* @param array $hook_extra Extra arguments passed to hooked filters.
@@ -649,9 +650,9 @@
* Default empty.
* @type bool $clear_destination Whether to delete any files already in the
* destination folder. Default false.
- * @type bool $clear_working Whether to delete the files form the working
- * directory after copying to the destination.
- * Default false.
+ * @type bool $clear_working Whether to delete the files from the working
+ * directory after copying them to the destination.
+ * Default true.
* @type bool $abort_if_destination_exists Whether to abort the installation if the destination
* folder already exists. When true, `$clear_destination`
* should be false. Default true.
@@ -671,8 +672,8 @@
'package' => '', // Please always pass this.
'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.
);
@@ -737,8 +738,8 @@
}
/*
- * 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'] );
@@ -833,8 +834,8 @@
* @since 3.7.0 Added to WP_Upgrader::run().
* @since 4.6.0 `$translations` was added as a possible argument to `$hook_extra`.
*
- * @param WP_Upgrader $this WP_Upgrader instance. In other contexts, $this, might be a
- * Theme_Upgrader, Plugin_Upgrader, Core_Upgrade, or Language_Pack_Upgrader instance.
+ * @param WP_Upgrader $upgrader WP_Upgrader instance. In other contexts this might be a
+ * Theme_Upgrader, Plugin_Upgrader, Core_Upgrade, or Language_Pack_Upgrader instance.
* @param array $hook_extra {
* Array of bulk item update data.
*
@@ -869,7 +870,7 @@
*
* @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.
*/
@@ -946,7 +947,6 @@
public static function release_lock( $lock_name ) {
return delete_option( $lock_name . '.lock' );
}
-
}
/** Plugin_Upgrader class */