Changeset 47122 for trunk/src/wp-admin/includes/class-wp-automatic-updater.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-admin/includes/class-wp-automatic-updater.php (modified) (15 diffs)

trunk/src/wp-admin/includes/class-wp-automatic-updater.php

@@ -142 +142 @@
         }
 
-        // Only relax the filesystem checks when the update doesn't include new files
+        // Only relax the filesystem checks when the update doesn't include new files.
         $allow_relaxed_file_ownership = false;
         if ( 'core' == $type && isset( $item->new_files ) && ! $item->new_files ) {
@@ -284 +284 @@
             case 'plugin':
                 $upgrader = new Plugin_Upgrader( $skin );
-                $context  = WP_PLUGIN_DIR; // We don't support custom Plugin directories, or updates for WPMU_PLUGIN_DIR
+                $context  = WP_PLUGIN_DIR; // We don't support custom Plugin directories, or updates for WPMU_PLUGIN_DIR.
                 break;
             case 'theme':
@@ -358 +358 @@
                 // Only available for core updates.
                 'attempt_rollback'             => true,
-                // Allow relaxed file ownership in some scenarios
+                // Allow relaxed file ownership in some scenarios.
                 'allow_relaxed_file_ownership' => $allow_relaxed_file_ownership,
             )
@@ -410 +410 @@
         }
 
-        // Don't automatically run these thins, as we'll handle it ourselves
+        // Don't automatically run these things, as we'll handle it ourselves.
         remove_action( 'upgrader_process_complete', array( 'Language_Pack_Upgrader', 'async_upgrade' ), 20 );
         remove_action( 'upgrader_process_complete', 'wp_version_check' );
@@ -416 +416 @@
         remove_action( 'upgrader_process_complete', 'wp_update_themes' );
 
-        // Next, Plugins
-        wp_update_plugins(); // Check for Plugin updates
+        // Next, plugins.
+        wp_update_plugins(); // Check for plugin updates.
         $plugin_updates = get_site_transient( 'update_plugins' );
         if ( $plugin_updates && ! empty( $plugin_updates->response ) ) {
@@ -423 +423 @@
                 $this->update( 'plugin', $plugin );
             }
-            // Force refresh of plugin update information
+            // Force refresh of plugin update information.
             wp_clean_plugins_cache();
         }
 
-        // Next, those themes we all love
-        wp_update_themes();  // Check for Theme updates
+        // Next, those themes we all love.
+        wp_update_themes();  // Check for theme updates.
         $theme_updates = get_site_transient( 'update_themes' );
         if ( $theme_updates && ! empty( $theme_updates->response ) ) {
@@ -434 +434 @@
                 $this->update( 'theme', (object) $theme );
             }
-            // Force refresh of theme update information
+            // Force refresh of theme update information.
             wp_clean_themes_cache();
         }
 
-        // Next, Process any core update
-        wp_version_check(); // Check for Core updates
+        // Next, process any core update.
+        wp_version_check(); // Check for core updates.
         $core_update = find_core_auto_update();
 
@@ -446 +446 @@
         }
 
-        // Clean up, and check for any pending translations
-        // (Core_Upgrader checks for core updates)
+        // Clean up, and check for any pending translations.
+        // (Core_Upgrader checks for core updates.)
         $theme_stats = array();
         if ( isset( $this->update_results['theme'] ) ) {
@@ -454 +454 @@
             }
         }
-        wp_update_themes( $theme_stats );  // Check for Theme updates
+        wp_update_themes( $theme_stats ); // Check for theme updates.
 
         $plugin_stats = array();
@@ -462 +462 @@
             }
         }
-        wp_update_plugins( $plugin_stats ); // Check for Plugin updates
-
-        // Finally, Process any new translations
+        wp_update_plugins( $plugin_stats ); // Check for plugin updates.
+
+        // Finally, process any new translations.
         $language_updates = wp_get_translation_updates();
         if ( $language_updates ) {
@@ -471 +471 @@
             }
 
-            // Clear existing caches
+            // Clear existing caches.
             wp_clean_update_cache();
 
-            wp_version_check();  // check for Core updates
-            wp_update_themes();  // Check for Theme updates
-            wp_update_plugins(); // Check for Plugin updates
+            wp_version_check();  // Check for core updates.
+            wp_update_themes();  // Check for theme updates.
+            wp_update_plugins(); // Check for plugin updates.
         }
 
@@ -627 +627 @@
 
         $next_user_core_update = get_preferred_from_update_core();
-        // If the update transient is empty, use the update we just performed
+        // If the update transient is empty, use the update we just performed.
         if ( ! $next_user_core_update ) {
             $next_user_core_update = $core_update;
@@ -861 +861 @@
         $body[] = sprintf( __( 'WordPress site: %s' ), network_home_url( '/' ) );
 
-        // Core
+        // Core.
         if ( isset( $this->update_results['core'] ) ) {
             $result = $this->update_results['core'][0];
@@ -875 +875 @@
         }
 
-        // Plugins, Themes, Translations
+        // Plugins, Themes, Translations.
         foreach ( array( 'plugin', 'theme', 'translation' ) as $type ) {
             if ( ! isset( $this->update_results[ $type ] ) ) {
@@ -895 +895 @@
             }
             if ( $success_items != $this->update_results[ $type ] ) {
-                // Failed updates
+                // Failed updates.
                 $messages = array(
                     'plugin'      => __( 'The following plugins failed to update:' ),