X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/dc1231b7312fbdca99e9e887cc2bb35a28f85cdc..refs/tags/wordpress-4.4:/wp-admin/includes/class-wp-upgrader.php
diff --git a/wp-admin/includes/class-wp-upgrader.php b/wp-admin/includes/class-wp-upgrader.php
index 235df514..d3abd8ea 100644
--- a/wp-admin/includes/class-wp-upgrader.php
+++ b/wp-admin/includes/class-wp-upgrader.php
@@ -1,10 +1,10 @@
skin->set_upgrader($this);
@@ -114,6 +121,7 @@ class WP_Upgrader {
* Add the generic strings to WP_Upgrader::$strings.
*
* @since 2.8.0
+ * @access public
*/
public function generic_strings() {
$this->strings['bad_request'] = __('Invalid Data provided.');
@@ -142,6 +150,7 @@ class WP_Upgrader {
* Connect to the filesystem.
*
* @since 2.8.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
@@ -205,6 +214,7 @@ class WP_Upgrader {
* Download a package.
*
* @since 2.8.0
+ * @access public
*
* @param string $package The URI of the package. If this is the full path to an
* existing local file, it will be returned untouched.
@@ -216,6 +226,7 @@ class WP_Upgrader {
* Filter whether to return the package.
*
* @since 3.7.0
+ * @access public
*
* @param bool $reply Whether to bail without returning the package.
* Default false.
@@ -246,6 +257,7 @@ class WP_Upgrader {
* Unpack a compressed package file.
*
* @since 2.8.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
@@ -297,6 +309,7 @@ class WP_Upgrader {
* Clears the directory where this item is going to be installed into.
*
* @since 4.3.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
@@ -360,6 +373,7 @@ class WP_Upgrader {
* clear out the destination folder if it already exists.
*
* @since 2.8.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
* @global array $wp_theme_directories
@@ -421,6 +435,7 @@ class WP_Upgrader {
* @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 ) ) {
return $res;
}
@@ -437,7 +452,7 @@ class WP_Upgrader {
$source = trailingslashit( $args['source'] ) . trailingslashit( $source_files[0] );
} elseif ( count( $source_files ) == 0 ) {
return new WP_Error( 'incompatible_archive_empty', $this->strings['incompatible_archive'], $this->strings['no_files'] ); // There are no files?
- } else { //It's only a single file, the upgrader will use the foldername of this file as the destination folder. foldername is based on zip filename.
+ } else { // It's only a single file, the upgrader will use the folder name of this file as the destination folder. Folder name is based on zip filename.
$source = trailingslashit( $args['source'] );
}
@@ -445,12 +460,15 @@ class WP_Upgrader {
* Filter the source file location for the upgrade package.
*
* @since 2.8.0
+ * @since 4.4.0 The $hook_extra parameter became available.
*
* @param string $source File source location.
- * @param string $remote_source Remove file source location.
+ * @param string $remote_source Remote file source location.
* @param WP_Upgrader $this WP_Upgrader instance.
+ * @param array $hook_extra Extra arguments passed to hooked filters.
*/
- $source = apply_filters( 'upgrader_source_selection', $source, $remote_source, $this );
+ $source = apply_filters( 'upgrader_source_selection', $source, $remote_source, $this, $args['hook_extra'] );
+
if ( is_wp_error( $source ) ) {
return $source;
}
@@ -459,6 +477,7 @@ class WP_Upgrader {
if ( $source !== $remote_source ) {
$source_files = array_keys( $wp_filesystem->dirlist( $source ) );
}
+
/*
* Protection against deleting files in any important base directories.
* Theme_Upgrader & Plugin_Upgrader also trigger this, as they pass the
@@ -471,13 +490,14 @@ class WP_Upgrader {
if ( is_array( $wp_theme_directories ) ) {
$protected_directories = array_merge( $protected_directories, $wp_theme_directories );
}
+
if ( in_array( $destination, $protected_directories ) ) {
$remote_destination = trailingslashit( $remote_destination ) . trailingslashit( basename( $source ) );
$destination = trailingslashit( $destination ) . trailingslashit( basename( $source ) );
}
if ( $clear_destination ) {
- // We're going to clear the destination if there's something there
+ // We're going to clear the destination if there's something there.
$this->skin->feedback('remove_old');
$removed = $this->clear_destination( $remote_destination );
@@ -561,6 +581,7 @@ class WP_Upgrader {
* install it in the destination folder.
*
* @since 2.8.0
+ * @access public
*
* @param array $options {
* Array or string of arguments for upgrading/installing a package.
@@ -584,7 +605,6 @@ class WP_Upgrader {
* @type array $hook_extra Extra arguments to pass to the filter hooks called by
* {@see WP_Upgrader::run()}.
* }
- *
* @return array|false|WP_error The result from self::install_package() on success, otherwise a WP_Error,
* or false if unable to connect to the filesystem.
*/
@@ -646,7 +666,10 @@ class WP_Upgrader {
return $res;
}
- //Download the package (Note, This just returns the filename of the file if the package is a local file)
+ /*
+ * Download the package (Note, This just returns the filename
+ * of the file if the package is a local file)
+ */
$download = $this->download_package( $options['package'] );
if ( is_wp_error($download) ) {
$this->skin->error($download);
@@ -659,7 +682,7 @@ class WP_Upgrader {
$delete_package = ( $download != $options['package'] ); // Do not delete a "local" file
- //Unzips the file into a temporary directory
+ // Unzips the file into a temporary directory.
$working_dir = $this->unpack_package( $download, $delete_package );
if ( is_wp_error($working_dir) ) {
$this->skin->error($working_dir);
@@ -670,7 +693,7 @@ class WP_Upgrader {
return $working_dir;
}
- //With the given options, this installs it to the destination directory.
+ // With the given options, this installs it to the destination directory.
$result = $this->install_package( array(
'source' => $working_dir,
'destination' => $options['destination'],
@@ -685,7 +708,7 @@ class WP_Upgrader {
$this->skin->error($result);
$this->skin->feedback('process_failed');
} else {
- //Install Succeeded
+ // Install succeeded.
$this->skin->feedback('process_success');
}
@@ -707,6 +730,7 @@ class WP_Upgrader {
* Creates/deletes the maintenance file to enable/disable maintenance mode.
*
* @since 2.8.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
@@ -730,11 +754,14 @@ class WP_Upgrader {
}
/**
- * Plugin Upgrader class for WordPress Plugins, It is designed to upgrade/install plugins from a local zip, remote zip URL, or uploaded zip file.
+ * Core class used for upgrading/installing plugins.
+ *
+ * It is designed to upgrade/install plugins from a local zip, remote zip URL,
+ * or uploaded zip file.
*
- * @package WordPress
- * @subpackage Upgrader
* @since 2.8.0
+ *
+ * @see WP_Upgrader
*/
class Plugin_Upgrader extends WP_Upgrader {
@@ -742,7 +769,9 @@ class Plugin_Upgrader extends WP_Upgrader {
* Plugin upgrade result.
*
* @since 2.8.0
+ * @access public
* @var array|WP_Error $result
+ *
* @see WP_Upgrader::$result
*/
public $result;
@@ -751,6 +780,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* Whether a bulk upgrade/install is being performed.
*
* @since 2.9.0
+ * @access public
* @var bool $bulk
*/
public $bulk = false;
@@ -759,6 +789,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* Initialize the upgrade strings.
*
* @since 2.8.0
+ * @access public
*/
public function upgrade_strings() {
$this->strings['up_to_date'] = __('The plugin is at the latest version.');
@@ -776,6 +807,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* Initialize the install strings.
*
* @since 2.8.0
+ * @access public
*/
public function install_strings() {
$this->strings['no_package'] = __('Install package not available.');
@@ -792,6 +824,7 @@ class Plugin_Upgrader extends WP_Upgrader {
*
* @since 2.8.0
* @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
+ * @access public
*
* @param string $package The full local path or URI of the package.
* @param array $args {
@@ -800,7 +833,6 @@ class Plugin_Upgrader extends WP_Upgrader {
* @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
* Default true.
* }
- *
* @return bool|WP_Error True if the install was successful, false or a WP_Error otherwise.
*/
public function install( $package, $args = array() ) {
@@ -814,6 +846,8 @@ class Plugin_Upgrader extends WP_Upgrader {
$this->install_strings();
add_filter('upgrader_source_selection', array($this, 'check_package') );
+ // Clear cache so wp_update_plugins() knows about the new plugin.
+ add_action( 'upgrader_process_complete', 'wp_clean_plugins_cache', 9, 0 );
$this->run( array(
'package' => $package,
@@ -826,6 +860,7 @@ class Plugin_Upgrader extends WP_Upgrader {
)
) );
+ remove_action( 'upgrader_process_complete', 'wp_clean_plugins_cache', 9 );
remove_filter('upgrader_source_selection', array($this, 'check_package') );
if ( ! $this->result || is_wp_error($this->result) )
@@ -842,10 +877,11 @@ class Plugin_Upgrader extends WP_Upgrader {
*
* @since 2.8.0
* @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
+ * @access public
*
* @param string $plugin The basename path to the main plugin file.
* @param array $args {
- * Optional. Other arguments for upgrading a plugin package. Defualt empty array.
+ * Optional. Other arguments for upgrading a plugin package. Default empty array.
*
* @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
* Default true.
@@ -908,6 +944,7 @@ class Plugin_Upgrader extends WP_Upgrader {
*
* @since 2.8.0
* @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
+ * @access public
*
* @param array $plugins Array of the basename paths of the plugins' main files.
* @param array $args {
@@ -916,7 +953,6 @@ class Plugin_Upgrader extends WP_Upgrader {
* @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.
*/
public function bulk_upgrade( $plugins, $args = array() ) {
@@ -945,10 +981,12 @@ class Plugin_Upgrader extends WP_Upgrader {
$this->skin->bulk_header();
- // Only start maintenance mode if:
- // - running Multisite and there are one or more plugins specified, OR
- // - a plugin with an update available is currently active.
- // @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
+ /*
+ * Only start maintenance mode if:
+ * - running Multisite and there are one or more plugins specified, OR
+ * - a plugin with an update available is currently active.
+ * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
+ */
$maintenance = ( is_multisite() && ! empty( $plugins ) );
foreach ( $plugins as $plugin )
$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
@@ -972,7 +1010,7 @@ class Plugin_Upgrader extends WP_Upgrader {
continue;
}
- // Get the URL to the zip file
+ // Get the URL to the zip file.
$r = $current->response[ $plugin ];
$this->skin->plugin_active = is_plugin_active($plugin);
@@ -1027,7 +1065,7 @@ class Plugin_Upgrader extends WP_Upgrader {
// Cleanup our hooks, in case something else does a upgrade on this connection.
remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'));
- // Force refresh of plugin update information
+ // Force refresh of plugin update information.
wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
return $results;
@@ -1040,11 +1078,13 @@ class Plugin_Upgrader extends WP_Upgrader {
* {@see Plugin_Upgrader::install()}.
*
* @since 3.3.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
* @param string $source The path to the downloaded package source.
- * @return string|WP_Error The source as passed, or a {@see WP_Error} object if no plugins were found.
+ * @return string|WP_Error The source as passed, or a {@see WP_Error} object
+ * if no plugins were found.
*/
public function check_package($source) {
global $wp_filesystem;
@@ -1081,6 +1121,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* This isn't used internally in the class, but is called by the skins.
*
* @since 2.8.0
+ * @access public
*
* @return string|false The full path to the main plugin file, or false.
*/
@@ -1106,6 +1147,7 @@ class Plugin_Upgrader extends WP_Upgrader {
*
* @since 2.8.0
* @since 4.1.0 Added a return value.
+ * @access public
*
* @param bool|WP_Error $return Upgrade offer return.
* @param array $plugin Plugin package arguments.
@@ -1139,6 +1181,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* {@see Plugin_Upgrader::upgrade()} and {@see Plugin_Upgrader::bulk_upgrade()}.
*
* @since 2.8.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
@@ -1178,11 +1221,14 @@ class Plugin_Upgrader extends WP_Upgrader {
}
/**
- * Theme Upgrader class for WordPress Themes, It is designed to upgrade/install themes from a local zip, remote zip URL, or uploaded zip file.
+ * Core class used for upgrading/installing themes.
+ *
+ * It is designed to upgrade/install themes from a local zip, remote zip URL,
+ * or uploaded zip file.
*
- * @package WordPress
- * @subpackage Upgrader
* @since 2.8.0
+ *
+ * @see WP_Upgrader
*/
class Theme_Upgrader extends WP_Upgrader {
@@ -1190,15 +1236,17 @@ class Theme_Upgrader extends WP_Upgrader {
* Result of the theme upgrade offer.
*
* @since 2.8.0
- * @var array|WP_Erorr $result
+ * @access public
+ * @var array|WP_Error $result
* @see WP_Upgrader::$result
*/
public $result;
/**
- * Whether multiple plugins are being upgraded/installed in bulk.
+ * Whether multiple themes are being upgraded/installed in bulk.
*
* @since 2.9.0
+ * @access public
* @var bool $bulk
*/
public $bulk = false;
@@ -1207,6 +1255,7 @@ class Theme_Upgrader extends WP_Upgrader {
* Initialize the upgrade strings.
*
* @since 2.8.0
+ * @access public
*/
public function upgrade_strings() {
$this->strings['up_to_date'] = __('The theme is at the latest version.');
@@ -1223,6 +1272,7 @@ class Theme_Upgrader extends WP_Upgrader {
* Initialize the install strings.
*
* @since 2.8.0
+ * @access public
*/
public function install_strings() {
$this->strings['no_package'] = __('Install package not available.');
@@ -1250,6 +1300,7 @@ class Theme_Upgrader extends WP_Upgrader {
* Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::install()}.
*
* @since 3.4.0
+ * @access public
*
* @param bool $install_result
* @param array $hook_extra
@@ -1323,6 +1374,7 @@ class Theme_Upgrader extends WP_Upgrader {
* a child theme and installing the parent theme fails.
*
* @since 3.4.0
+ * @access public
*
* @param array $actions Preview actions.
* @return array
@@ -1337,6 +1389,7 @@ class Theme_Upgrader extends WP_Upgrader {
*
* @since 2.8.0
* @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
+ * @access public
*
* @param string $package The full local path or URI of the package.
* @param array $args {
@@ -1360,6 +1413,8 @@ class Theme_Upgrader extends WP_Upgrader {
add_filter('upgrader_source_selection', array($this, 'check_package') );
add_filter('upgrader_post_install', array($this, 'check_parent_theme_filter'), 10, 3);
+ // Clear cache so wp_update_themes() knows about the new theme.
+ add_action( 'upgrader_process_complete', 'wp_clean_themes_cache', 9, 0 );
$this->run( array(
'package' => $package,
@@ -1372,6 +1427,7 @@ class Theme_Upgrader extends WP_Upgrader {
),
) );
+ remove_action( 'upgrader_process_complete', 'wp_clean_themes_cache', 9 );
remove_filter('upgrader_source_selection', array($this, 'check_package') );
remove_filter('upgrader_post_install', array($this, 'check_parent_theme_filter'));
@@ -1389,6 +1445,7 @@ class Theme_Upgrader extends WP_Upgrader {
*
* @since 2.8.0
* @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
+ * @access public
*
* @param string $theme The theme slug.
* @param array $args {
@@ -1454,6 +1511,7 @@ class Theme_Upgrader extends WP_Upgrader {
*
* @since 3.0.0
* @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
+ * @access public
*
* @param array $themes The theme slugs.
* @param array $args {
@@ -1574,6 +1632,7 @@ class Theme_Upgrader extends WP_Upgrader {
* files.
*
* @since 3.3.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
@@ -1592,17 +1651,35 @@ class Theme_Upgrader extends WP_Upgrader {
return $source;
// A proper archive should have a style.css file in the single subdirectory
- if ( ! file_exists( $working_directory . 'style.css' ) )
- return new WP_Error( 'incompatible_archive_theme_no_style', $this->strings['incompatible_archive'], __( 'The theme is missing the style.css stylesheet.' ) );
+ if ( ! file_exists( $working_directory . 'style.css' ) ) {
+ return new WP_Error( 'incompatible_archive_theme_no_style', $this->strings['incompatible_archive'],
+ /* translators: %s: style.css */
+ sprintf( __( 'The theme is missing the %s stylesheet.' ),
+ 'style.css'
+ )
+ );
+ }
$info = get_file_data( $working_directory . 'style.css', array( 'Name' => 'Theme Name', 'Template' => 'Template' ) );
- if ( empty( $info['Name'] ) )
- return new WP_Error( 'incompatible_archive_theme_no_name', $this->strings['incompatible_archive'], __( "The style.css stylesheet doesn't contain a valid theme header." ) );
+ if ( empty( $info['Name'] ) ) {
+ return new WP_Error( 'incompatible_archive_theme_no_name', $this->strings['incompatible_archive'],
+ /* translators: %s: style.css */
+ sprintf( __( 'The %s stylesheet doesn’t contain a valid theme header.' ),
+ 'style.css'
+ )
+ );
+ }
// If it's not a child theme, it must have at least an index.php to be legit.
- if ( empty( $info['Template'] ) && ! file_exists( $working_directory . 'index.php' ) )
- return new WP_Error( 'incompatible_archive_theme_no_index', $this->strings['incompatible_archive'], __( 'The theme is missing the index.php file.' ) );
+ if ( empty( $info['Template'] ) && ! file_exists( $working_directory . 'index.php' ) ) {
+ return new WP_Error( 'incompatible_archive_theme_no_index', $this->strings['incompatible_archive'],
+ /* translators: %s: index.php */
+ sprintf( __( 'The theme is missing the %s file.' ),
+ 'index.php'
+ )
+ );
+ }
return $source;
}
@@ -1614,6 +1691,7 @@ class Theme_Upgrader extends WP_Upgrader {
* {@see Theme_Upgrader::bulk_upgrade()}.
*
* @since 2.8.0
+ * @access public
*
* @param bool|WP_Error $return
* @param array $theme
@@ -1641,6 +1719,7 @@ class Theme_Upgrader extends WP_Upgrader {
* and {@see Theme_Upgrader::bulk_upgrade()}.
*
* @since 2.8.0
+ * @access public
*
* @param bool|WP_Error $return
* @param array $theme
@@ -1675,6 +1754,7 @@ class Theme_Upgrader extends WP_Upgrader {
* and {@see Theme_Upgrader::bulk_upgrade()}.
*
* @since 2.8.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
@@ -1708,6 +1788,7 @@ class Theme_Upgrader extends WP_Upgrader {
*
* @since 2.8.0
* @since 3.0.0 The `$theme` argument was added.
+ * @access public
*
* @param string $theme The directory name of the theme. This is optional, and if not supplied,
* the directory name from the last result will be used.
@@ -1728,11 +1809,12 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
- * Language pack upgrader, for updating translations of plugins, themes, and core.
+ * Core class used for updating/installing language packs (translations)
+ * for plugins, themes, and core.
*
- * @package WordPress
- * @subpackage Upgrader
* @since 3.7.0
+ *
+ * @see WP_Upgrader
*/
class Language_Pack_Upgrader extends WP_Upgrader {
@@ -1740,6 +1822,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
* Result of the language pack upgrade.
*
* @since 3.7.0
+ * @access public
* @var array|WP_Error $result
* @see WP_Upgrader::$result
*/
@@ -1749,20 +1832,23 @@ class Language_Pack_Upgrader extends WP_Upgrader {
* Whether a bulk upgrade/install is being performed.
*
* @since 3.7.0
+ * @access public
* @var bool $bulk
*/
public $bulk = true;
/**
- * Asynchronously upgrade language packs after other upgrades have been made.
+ * Asynchronously upgrades language packs after other upgrades have been made.
*
* Hooked to the {@see 'upgrader_process_complete'} action by default.
*
* @since 3.7.0
- *
+ * @access public
* @static
*
- * @param false|WP_Upgrader $upgrader
+ * @param false|WP_Upgrader $upgrader Optional. WP_Upgrader instance or false. If `$upgrader` is
+ * a Language_Pack_Upgrader instance, the method will bail to
+ * avoid recursion. Otherwise unused. Default false.
*/
public static function async_upgrade( $upgrader = false ) {
// Avoid recursion.
@@ -1776,8 +1862,10 @@ class Language_Pack_Upgrader extends WP_Upgrader {
return;
}
- // Avoid messing with VCS installs, at least for now.
- // Noted: this is not the ideal way to accomplish this.
+ /*
+ * Avoid messing with VCS installs, at least for now.
+ * Noted: this is not the ideal way to accomplish this.
+ */
$check_vcs = new WP_Automatic_Updater;
if ( $check_vcs->is_vcs_checkout( WP_CONTENT_DIR ) ) {
return;
@@ -1805,9 +1893,14 @@ class Language_Pack_Upgrader extends WP_Upgrader {
return;
}
- $skin = new Language_Pack_Upgrader_Skin( array(
- 'skip_header_footer' => true,
- ) );
+ // Re-use the automatic upgrader skin if the parent upgrader is using it.
+ if ( $upgrader && $upgrader->skin instanceof Automatic_Upgrader_Skin ) {
+ $skin = $upgrader->skin;
+ } else {
+ $skin = new Language_Pack_Upgrader_Skin( array(
+ 'skip_header_footer' => true,
+ ) );
+ }
$lp_upgrader = new Language_Pack_Upgrader( $skin );
$lp_upgrader->bulk_upgrade( $language_updates );
@@ -1817,6 +1910,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
* Initialize the upgrade strings.
*
* @since 3.7.0
+ * @access public
*/
public function upgrade_strings() {
$this->strings['starting_upgrade'] = __( 'Some of your translations need updating. Sit tight for a few more seconds while we update them as well.' );
@@ -1832,6 +1926,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
* Upgrade a language pack.
*
* @since 3.7.0
+ * @access public
*
* @param string|false $update Optional. Whether an update offer is available. Default false.
* @param array $args Optional. Other optional arguments, see
@@ -1856,6 +1951,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
* Bulk upgrade language packs.
*
* @since 3.7.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
@@ -1983,6 +2079,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
* {@see Language_Pack_Upgrader::bulk_upgrade()}.
*
* @since 3.7.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
@@ -2007,9 +2104,15 @@ class Language_Pack_Upgrader extends WP_Upgrader {
$mo = true;
}
- if ( ! $mo || ! $po )
+ if ( ! $mo || ! $po ) {
return new WP_Error( 'incompatible_archive_pomo', $this->strings['incompatible_archive'],
- __( 'The language pack is missing either the .po or .mo files.' ) );
+ /* translators: 1: .po 2: .mo */
+ sprintf( __( 'The language pack is missing either the %1$s or %2$s files.' ),
+ '.po',
+ '.mo'
+ )
+ );
+ }
return $source;
}
@@ -2018,6 +2121,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
* Get the name of an item being updated.
*
* @since 3.7.0
+ * @access public
*
* @param object $update The data for an update.
* @return string The name of the item being updated.
@@ -2045,11 +2149,14 @@ class Language_Pack_Upgrader extends WP_Upgrader {
}
/**
- * Core Upgrader class for WordPress. It allows for WordPress to upgrade itself in combination with the wp-admin/includes/update-core.php file
+ * Core class used for updating core.
+ *
+ * It allows for WordPress to upgrade itself in combination with
+ * the wp-admin/includes/update-core.php file.
*
- * @package WordPress
- * @subpackage Upgrader
* @since 2.8.0
+ *
+ * @see WP_Upgrader
*/
class Core_Upgrader extends WP_Upgrader {
@@ -2057,6 +2164,7 @@ class Core_Upgrader extends WP_Upgrader {
* Initialize the upgrade strings.
*
* @since 2.8.0
+ * @access public
*/
public function upgrade_strings() {
$this->strings['up_to_date'] = __('WordPress is at the latest version.');
@@ -2073,9 +2181,10 @@ class Core_Upgrader extends WP_Upgrader {
* Upgrade WordPress core.
*
* @since 2.8.0
+ * @access public
*
* @global WP_Filesystem_Base $wp_filesystem Subclass
- * @global callback $_wp_filesystem_direct_method
+ * @global callable $_wp_filesystem_direct_method
*
* @param object $current Response object for whether WordPress is current.
* @param array $args {
@@ -2243,6 +2352,7 @@ class Core_Upgrader extends WP_Upgrader {
* Determines if this WordPress Core version should update to an offered version or not.
*
* @since 3.7.0
+ * @access public
*
* @static
*
@@ -2348,9 +2458,10 @@ class Core_Upgrader extends WP_Upgrader {
}
/**
- * Compare the disk file checksums agains the expected checksums.
+ * Compare the disk file checksums against the expected checksums.
*
* @since 3.7.0
+ * @access public
*
* @global string $wp_version
* @global string $wp_local_package
@@ -2378,10 +2489,11 @@ class Core_Upgrader extends WP_Upgrader {
}
/**
- * Upgrade Skin helper for File uploads. This class handles the upload process and passes it as if it's a local file to the Upgrade/Installer functions.
+ * Core class used for handling file uploads.
+ *
+ * This class handles the upload process and passes it as if it's a local file
+ * to the Upgrade/Installer functions.
*
- * @package WordPress
- * @subpackage Upgrader
* @since 2.8.0
*/
class File_Upload_Upgrader {
@@ -2390,6 +2502,7 @@ class File_Upload_Upgrader {
* The full path to the file package.
*
* @since 2.8.0
+ * @access public
* @var string $package
*/
public $package;
@@ -2398,6 +2511,7 @@ class File_Upload_Upgrader {
* The name of the file.
*
* @since 2.8.0
+ * @access public
* @var string $filename
*/
public $filename;
@@ -2406,6 +2520,7 @@ class File_Upload_Upgrader {
* The ID of the attachment post for this file.
*
* @since 3.3.0
+ * @access public
* @var int $id
*/
public $id = 0;
@@ -2414,6 +2529,7 @@ class File_Upload_Upgrader {
* Construct the upgrader for a form.
*
* @since 2.8.0
+ * @access public
*
* @param string $form The name of the form the file was uploaded from.
* @param string $urlholder The name of the `GET` parameter that holds the filename.
@@ -2473,6 +2589,7 @@ class File_Upload_Upgrader {
* Delete the attachment/uploaded file.
*
* @since 3.2.2
+ * @access public
*
* @return bool Whether the cleanup was successful.
*/
@@ -2488,10 +2605,8 @@ class File_Upload_Upgrader {
}
/**
- * The WordPress automatic background updater.
+ * Core class used for handling automatic background updates.
*
- * @package WordPress
- * @subpackage Upgrader
* @since 3.7.0
*/
class WP_Automatic_Updater {
@@ -2500,6 +2615,7 @@ class WP_Automatic_Updater {
* Tracks update results during processing.
*
* @var array
+ * @access protected
*/
protected $update_results = array();
@@ -2507,13 +2623,14 @@ class WP_Automatic_Updater {
* Whether the entire automatic updater is disabled.
*
* @since 3.7.0
+ * @access public
*/
public function is_disabled() {
// Background updates are disabled if you don't want file changes.
if ( defined( 'DISALLOW_FILE_MODS' ) && DISALLOW_FILE_MODS )
return true;
- if ( defined( 'WP_INSTALLING' ) )
+ if ( wp_installing() )
return true;
// More fine grained control can be done through the WP_AUTO_UPDATE_CORE constant and filters.
@@ -2547,6 +2664,7 @@ class WP_Automatic_Updater {
* how things get updated.
*
* @since 3.7.0
+ * @access public
*
* @param string $context The filesystem path to check, in addition to ABSPATH.
*/
@@ -2599,8 +2717,9 @@ class WP_Automatic_Updater {
* Tests to see if we can and should update a specific item.
*
* @since 3.7.0
+ * @access public
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $type The type of update being checked: 'core', 'theme',
* 'plugin', 'translation'.
@@ -2682,6 +2801,7 @@ class WP_Automatic_Updater {
* Notifies an administrator of a core update.
*
* @since 3.7.0
+ * @access protected
*
* @param object $item The update offer.
*/
@@ -2725,6 +2845,7 @@ class WP_Automatic_Updater {
* Update an item, if appropriate.
*
* @since 3.7.0
+ * @access public
*
* @param string $type The type of update being checked: 'core', 'theme', 'plugin', 'translation'.
* @param object $item The update offer.
@@ -2759,6 +2880,18 @@ class WP_Automatic_Updater {
if ( ! $this->should_update( $type, $item, $context ) )
return false;
+ /**
+ * Fires immediately prior to an auto-update.
+ *
+ * @since 4.4.0
+ *
+ * @param string $type The type of update being checked: 'core', 'theme', 'plugin', or 'translation'.
+ * @param object $item The update offer.
+ * @param string $context The filesystem context (a path) against which filesystem access and status
+ * should be checked.
+ */
+ do_action( 'pre_auto_update', $type, $item, $context );
+
$upgrader_item = $item;
switch ( $type ) {
case 'core':
@@ -2828,6 +2961,7 @@ class WP_Automatic_Updater {
* Kicks off the background update process, looping through all pending updates.
*
* @since 3.7.0
+ * @access public
*
* @global wpdb $wpdb
* @global string $wp_version
@@ -2966,6 +3100,9 @@ class WP_Automatic_Updater {
* If we tried to perform a core update, check if we should send an email,
* and if we need to avoid processing future updates.
*
+ * @since Unknown
+ * @access protected
+ *
* @global string $wp_version
*
* @param object|WP_Error $update_result The result of the core update. Includes the update offer and result.
@@ -3054,6 +3191,7 @@ class WP_Automatic_Updater {
* Sends an email upon the completion or failure of a background core update.
*
* @since 3.7.0
+ * @access protected
*
* @global string $wp_version
*
@@ -3253,6 +3391,7 @@ class WP_Automatic_Updater {
* Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
*
* @since 3.7.0
+ * @access protected
*/
protected function send_debug_email() {
$update_count = 0;