Changeset 47122 for trunk/src/wp-admin/includes/class-plugin-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-plugin-upgrader.php (modified) (12 diffs)

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

@@ -124 +124 @@
         }
 
-        // Force refresh of plugin update information
+        // Force refresh of plugin update information.
         wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
 
@@ -164 +164 @@
         }
 
-        // Get the URL to the zip file
+        // Get the URL to the zip file.
         $r = $current->response[ $plugin ];
 
         add_filter( 'upgrader_pre_install', array( $this, 'deactivate_plugin_before_upgrade' ), 10, 2 );
         add_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ), 10, 4 );
-        //'source_selection' => array($this, 'source_selection'), //there's a trac ticket to move up the directory for zip's which are made a bit differently, useful for non-.org plugins.
+        // There's a Trac ticket to move up the directory for zips which are made a bit differently, useful for non-.org plugins.
+        // 'source_selection' => array( $this, 'source_selection' ),
         if ( $parsed_args['clear_update_cache'] ) {
             // Clear cache so wp_update_plugins() knows about the new plugin.
@@ -198 +199 @@
         }
 
-        // Force refresh of plugin update information
+        // Force refresh of plugin update information.
         wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
 
@@ -235 +236 @@
         $this->skin->header();
 
-        // Connect to the Filesystem first.
+        // Connect to the filesystem first.
         $res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
         if ( ! $res ) {
@@ -248 +249 @@
          * - 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.
+         * @todo For multisite, maintenance mode should only kick in for individual sites if at all possible.
          */
         $maintenance = ( is_multisite() && ! empty( $plugins ) );
@@ -295 +296 @@
             $results[ $plugin ] = $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 $plugins.
 
         $this->maintenance_mode( false );
@@ -354 +355 @@
         }
 
-        // Check the folder contains at least 1 valid plugin.
+        // Check that the folder contains at least 1 valid plugin.
         $plugins_found = false;
         $files         = glob( $working_directory . '*.php' );
@@ -391 +392 @@
         }
 
-        $plugin = get_plugins( '/' . $this->result['destination_name'] ); //Ensure to pass with leading slash
+        // Ensure to pass with leading slash.
+        $plugin = get_plugins( '/' . $this->result['destination_name'] );
         if ( empty( $plugin ) ) {
             return false;
         }
 
-        $pluginfiles = array_keys( $plugin ); //Assume the requested plugin is the first in the list
+        // Assume the requested plugin is the first in the list.
+        $pluginfiles = array_keys( $plugin );
 
         return $this->result['destination_name'] . '/' . $pluginfiles[0];
@@ -415 +418 @@
     public function deactivate_plugin_before_upgrade( $return, $plugin ) {
 
-        if ( is_wp_error( $return ) ) { //Bypass.
+        if ( is_wp_error( $return ) ) { // Bypass.
             return $return;
         }
 
-        // When in cron (background updates) don't deactivate the plugin, as we require a browser to reactivate it
+        // When in cron (background updates) don't deactivate the plugin, as we require a browser to reactivate it.
         if ( wp_doing_cron() ) {
             return $return;
@@ -430 +433 @@
 
         if ( is_plugin_active( $plugin ) ) {
-            //Deactivate the plugin silently, Prevent deactivation hooks from running.
+            // Deactivate the plugin silently, Prevent deactivation hooks from running.
             deactivate_plugins( $plugin, true );
         }
@@ -457 +460 @@
 
         if ( is_wp_error( $removed ) ) {
-            return $removed; //Pass errors through.
+            return $removed; // Pass errors through.
         }
 
@@ -468 +471 @@
         $this_plugin_dir = trailingslashit( dirname( $plugins_dir . $plugin ) );
 
-        if ( ! $wp_filesystem->exists( $this_plugin_dir ) ) { //If it's already vanished.
+        if ( ! $wp_filesystem->exists( $this_plugin_dir ) ) { // If it's already vanished.
             return $removed;
         }
 
         // If plugin is in its own directory, recursively delete the directory.
-        if ( strpos( $plugin, '/' ) && $this_plugin_dir != $plugins_dir ) { //base check on if plugin includes directory separator AND that it's not the root plugin folder
+        // Base check on if plugin includes directory separator AND that it's not the root plugin folder.
+        if ( strpos( $plugin, '/' ) && $this_plugin_dir != $plugins_dir ) {
             $deleted = $wp_filesystem->delete( $this_plugin_dir, true );
         } else {