enmi-conf.org: comparison wp/wp-admin/includes/class-wp-upgrader.php

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 		$this->strings['installing_package']   = __( 'Installing the latest version&#8230;' );
 		$this->strings['no_files']             = __( 'The package contains no files.' );
 		$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&#8230;' );
 		$this->strings['maintenance_end']   = __( 'Disabling Maintenance mode&#8230;' );
 	}
 	/**
 	 * 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
 	 *                                 existing local file, it will be returned untouched.
 	 * @param bool   $check_signatures Whether to validate file signatures. Default false.
 	 *
 	 * @since 4.3.0
 	 *
 	 * @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.
+	 * @return true|WP_Error True upon success, WP_Error on failure.
 	 */
 	public function clear_destination( $remote_destination ) {
 		global $wp_filesystem;
 		$files = $wp_filesystem->dirlist( $remote_destination, true, true );
 	}
 	/**
 	 * 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.
 	 *
 	 * @since 2.8.0
 	 *
 	 *     @type string $source                      Required path to the package source. Default empty.
 	 *     @type string $destination                 Required path to a folder to install the package in.
 	 *                                               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
+	 *     @type bool   $clear_working               Whether to delete the files from the working directory
-	 *                                               after copying to the destination. Default false.
+	 *                                               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
 	 *                                               WP_Upgrader::install_package(). Default empty array.
 	 * }
 			return new WP_Error( 'bad_request', $this->strings['bad_request'] );
 		}
 		$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
+		 * Returning a value that could be evaluated as a `WP_Error` will effectively
-		 * will effectively short-circuit the installation, returning that value
+		 * short-circuit the installation, returning that value instead.
-		 * 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'] );
 		if ( is_wp_error( $res ) ) {
 			/**
 			 * Filters whether the upgrader cleared the destination.
 			 *
 			 * @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.
 			 */
 			$removed = apply_filters( 'upgrader_clear_destination', $removed, $local_destination, $remote_destination, $args['hook_extra'] );
 	 *                                               Default empty.
 	 *     @type string $destination                 The full path to the destination folder.
 	 *                                               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
+	 *     @type bool   $clear_working               Whether to delete the files from the working
-	 *                                               directory after copying to the destination.
+	 *                                               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`
 	 *                                               should be false. Default true.
 	 *     @type bool   $is_multi                    Whether this run is one of multiple upgrade/installation
 	 *                                               actions being performed in bulk. When true, the skin
 		$defaults = array(
 			'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.
 		);
 		$options = wp_parse_args( $options, $defaults );
 			}
 			return $res;
 		}
 		/*
-		 * Download the package (Note, This just returns the filename
+		 * Download the package. Note: If the package is the full path
-		 * of the file if the package is a local file)
+		 * to an existing local file, it will be returned untouched.
 		 */
 		$download = $this->download_package( $options['package'], true, $options['hook_extra'] );
 		// Allow for signature soft-fail.
 		// WARNING: This may be removed in the future.
 			 *
 			 * @since 3.6.0
 			 * @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
+			 * @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.
+			 *                                Theme_Upgrader, Plugin_Upgrader, Core_Upgrade, or Language_Pack_Upgrader instance.
 			 * @param array       $hook_extra {
 			 *     Array of bulk item update data.
 			 *
 			 *     @type string $action       Type of action. Default 'update'.
 			 *     @type string $type         Type of update process. Accepts 'plugin', 'theme', 'translation', or 'core'.
 	 *
 	 * Creates/deletes the maintenance file to enable/disable maintenance mode.
 	 *
 	 * @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.
 	 */
 	public function maintenance_mode( $enable = false ) {
 		global $wp_filesystem;
 	 * @return bool True if the lock was successfully released. False on failure.
 	 */
 	public static function release_lock( $lock_name ) {
 		return delete_option( $lock_name . '.lock' );
 	}
 }
 /** Plugin_Upgrader class */
 require_once ABSPATH . 'wp-admin/includes/class-plugin-upgrader.php';

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6