Changeset 47122 for trunk/src/wp-admin/includes/class-theme-upgrader.php

Timestamp:

01/29/2020 12:43:23 AM (6 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-theme-upgrader.php (modified) (16 diffs)

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

@@ -95 +95 @@
      */
     public function check_parent_theme_filter( $install_result, $hook_extra, $child_result ) {
-        // Check to see if we need to install a parent theme
+        // Check to see if we need to install a parent theme.
         $theme_info = $this->theme_info();
 
@@ -120 +120 @@
                 ),
             )
-        ); //Save on a bit of bandwidth.
+        ); // Save on a bit of bandwidth.
 
         if ( ! $api || is_wp_error( $api ) ) {
             $this->skin->feedback( 'parent_theme_not_found', $theme_info->get( 'Template' ) );
-            // Don't show activate or preview actions after installation
+            // Don't show activate or preview actions after installation.
             add_filter( 'install_theme_complete_actions', array( $this, 'hide_activate_preview_actions' ) );
             return $install_result;
@@ -133 +133 @@
         $child_success_message = $this->strings['process_success'];
 
-        // Override them
-        $this->skin->api                           = $api;
-        $this->strings['process_success_specific'] = $this->strings['parent_theme_install_success'];//, $api->name, $api->version);
+        // Override them.
+        $this->skin->api = $api;
+
+        $this->strings['process_success_specific'] = $this->strings['parent_theme_install_success']; //, $api->name, $api->version );
 
         $this->skin->feedback( 'parent_theme_prepare_install', $api->name, $api->version );
@@ -141 +142 @@
         add_filter( 'install_theme_complete_actions', '__return_false', 999 ); // Don't show any actions after installing the theme.
 
-        // Install the parent theme
+        // Install the parent theme.
         $parent_result = $this->run(
             array(
                 'package'           => $api->download_link,
                 'destination'       => get_theme_root(),
-                'clear_destination' => false, //Do not overwrite files.
+                'clear_destination' => false, // Do not overwrite files.
                 'clear_working'     => true,
             )
@@ -155 +156 @@
         }
 
-        // Start cleaning up after the parents installation
+        // Start cleaning up after the parent's installation.
         remove_filter( 'install_theme_complete_actions', '__return_false', 999 );
 
-        // Reset child's result and data
+        // Reset child's result and data.
         $this->result                     = $child_result;
         $this->skin->api                  = $child_api;
@@ -220 +221 @@
                 'package'           => $package,
                 'destination'       => get_theme_root(),
-                'clear_destination' => false, //Do not overwrite files.
+                'clear_destination' => false, // Do not overwrite files.
                 'clear_working'     => true,
                 'hook_extra'        => array(
@@ -237 +238 @@
         }
 
-        // Refresh the Theme Update information
+        // Refresh the Theme Update information.
         wp_clean_themes_cache( $parsed_args['clear_update_cache'] );
 
@@ -350 +351 @@
         $this->skin->header();
 
-        // Connect to the Filesystem first.
+        // Connect to the filesystem first.
         $res = $this->fs_connect( array( WP_CONTENT_DIR ) );
         if ( ! $res ) {
@@ -359 +360 @@
         $this->skin->bulk_header();
 
-        // Only start maintenance mode if:
-        // - running Multisite and there are one or more themes specified, OR
-        // - a theme with an update available is currently in use.
-        // @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 themes specified, OR
+         * - a theme with an update available is currently in use.
+         * @todo For multisite, maintenance mode should only kick in for individual sites if at all possible.
+         */
         $maintenance = ( is_multisite() && ! empty( $themes ) );
         foreach ( $themes as $theme ) {
@@ -389 +392 @@
             }
 
-            // Get the URL to the zip file
+            // Get the URL to the zip file.
             $r = $current->response[ $theme ];
 
@@ -407 +410 @@
             $results[ $theme ] = $this->result;
 
-            // Prevent credentials auth screen from displaying multiple times
+            // Prevent credentials auth screen from displaying multiple times.
             if ( false === $result ) {
                 break;
             }
-        } //end foreach $plugins
+        } // End foreach $themes.
 
         $this->maintenance_mode( false );
 
-        // Refresh the Theme Update information
+        // Refresh the Theme Update information.
         wp_clean_themes_cache( $parsed_args['clear_update_cache'] );
 
@@ -463 +466 @@
         }
 
-        // Check the folder contains a valid theme
+        // Check that the folder contains a valid theme.
         $working_directory = str_replace( $wp_filesystem->wp_content_dir(), trailingslashit( WP_CONTENT_DIR ), $source );
         if ( ! is_dir( $working_directory ) ) { // Sanity check, if the above fails, let's not prevent installation.
@@ -469 +472 @@
         }
 
-        // A proper archive should have a style.css file in the single subdirectory
+        // A proper archive should have a style.css file in the single subdirectory.
         if ( ! file_exists( $working_directory . 'style.css' ) ) {
             return new WP_Error(
@@ -537 +540 @@
         $theme = isset( $theme['theme'] ) ? $theme['theme'] : '';
 
-        if ( $theme != get_stylesheet() ) { //If not current
+        if ( $theme != get_stylesheet() ) { // If not current.
             return $return;
         }
-        //Change to maintenance mode now.
+
+        // Change to maintenance mode now.
         if ( ! $this->bulk ) {
             $this->maintenance_mode( true );
@@ -567 +571 @@
         $theme = isset( $theme['theme'] ) ? $theme['theme'] : '';
 
-        if ( $theme != get_stylesheet() ) { // If not current
+        if ( $theme != get_stylesheet() ) { // If not current.
             return $return;
         }
@@ -578 +582 @@
         }
 
-        //Time to remove maintenance mode
+        // Time to remove maintenance mode.
         if ( ! $this->bulk ) {
             $this->maintenance_mode( false );