Changeset 47409

Timestamp:

03/03/2020 12:27:52 AM (7 years ago)

Author:

johnbillion

Message:

Upgrade/Install: Improved inline docs for the plugin and theme updater maintenance mode functionality.

Props bookdude13

See #49400

Location:

trunk/src/wp-admin/includes

Files:

• class-plugin-upgrader.php (modified) (8 diffs)
• class-theme-upgrader.php (modified) (5 diffs)

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

@@ -445 +445 @@
 
         /**
-         * Turn on maintenance mode before attempting to background update an active plugin.
+         * Turns on maintenance mode before attempting to background update an active plugin.
          *
          * Hooked to the {@see 'upgrader_pre_install'} filter by Plugin_Upgrader::upgrade().
@@ -451 +451 @@
          * @since 5.4.0
          *
-         * @param bool|WP_Error  $return
-         * @param array          $plugin
-         * @return bool|WP_Error
+         * @param bool|WP_Error $return Upgrade offer return.
+         * @param array         $plugin Plugin package arguments.
+         * @return bool|WP_Error The passed in $return param or WP_Error.
          */
         public function active_before( $return, $plugin ) {
@@ -467 +467 @@
                 $plugin = isset( $plugin['plugin'] ) ? $plugin['plugin'] : '';
 
-                if ( ! is_plugin_active( $plugin ) ) { // If not active.
-                        return $return;
-                }
-
-                // Bulk edit handles maintenance mode separately.
+                // Only run if plugin is active
+                if ( ! is_plugin_active( $plugin ) ) {
+                        return $return;
+                }
+
+                // Change to maintenance mode. Bulk edit handles this separately.
                 if ( ! $this->bulk ) {
                         $this->maintenance_mode( true );
@@ -480 +481 @@
 
         /**
-         * Turn off maintenance mode after upgrading an active plugin.
+         * Turns off maintenance mode after upgrading an active plugin.
          *
          * Hooked to the {@see 'upgrader_post_install'} filter by Plugin_Upgrader::upgrade().
@@ -486 +487 @@
          * @since 5.4.0
          *
-         * @param bool|WP_Error  $return
-         * @param array          $plugin
-         * @return bool|WP_Error
+         * @param bool|WP_Error  $return Upgrade offer return.
+         * @param array          $plugin Plugin package arguments.
+         * @return bool|WP_Error The passed in $return param or WP_Error.
          */
         public function active_after( $return, $plugin ) {
@@ -502 +503 @@
                 $plugin = isset( $plugin['plugin'] ) ? $plugin['plugin'] : '';
 
-                if ( ! is_plugin_active( $plugin ) ) { // If not active.
-                        return $return;
-                }
-
-                // Bulk edit handles maintenance mode separately.
+                // Only run if plugin is active
+                if ( ! is_plugin_active( $plugin ) ) {
+                        return $return;
+                }
+
+                // Time to remove maintenance mode. Bulk edit handles this separately.
                 if ( ! $this->bulk ) {
                         $this->maintenance_mode( false );
@@ -515 +517 @@
 
         /**
-         * Delete the old plugin during an upgrade.
+         * Deletes the old plugin during an upgrade.
          *
          * Hooked to the {@see 'upgrader_clear_destination'} filter by
@@ -524 +526 @@
          * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
          *
-         * @param bool|WP_Error $removed
-         * @param string        $local_destination
-         * @param string        $remote_destination
-         * @param array         $plugin
+         * @param bool|WP_Error $removed            Whether the destination was cleared. true on success, WP_Error on failure.
+         * @param string        $local_destination  The local package destination.
+         * @param string        $remote_destination The remote package destination.
+         * @param array         $plugin             Extra arguments passed to hooked filters.
          * @return bool|WP_Error
          */

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

@@ -529 +529 @@
          * @since 2.8.0
          *
-         * @param bool|WP_Error  $return
-         * @param array          $theme
-         * @return bool|WP_Error
+         * @param bool|WP_Error $return Upgrade offer return.
+         * @param array         $theme Theme arguments.
+         * @return bool|WP_Error The passed in $return param or WP_Error.
          */
         public function current_before( $return, $theme ) {
@@ -540 +540 @@
                 $theme = isset( $theme['theme'] ) ? $theme['theme'] : '';
 
-                if ( get_stylesheet() !== $theme ) { // If not current.
+                // Only run if current theme
+                if ( get_stylesheet() !== $theme ) {
                         return $return;
                 }
 
-                // Change to maintenance mode now.
+                // Change to maintenance mode. Bulk edit handles this separately.
                 if ( ! $this->bulk ) {
                         $this->maintenance_mode( true );
@@ -560 +561 @@
          * @since 2.8.0
          *
-         * @param bool|WP_Error  $return
-         * @param array          $theme
-         * @return bool|WP_Error
+         * @param bool|WP_Error $return Upgrade offer return.
+         * @param array         $theme Theme arguments.
+         * @return bool|WP_Error The passed in $return param or WP_Error.
          */
         public function current_after( $return, $theme ) {
@@ -571 +572 @@
                 $theme = isset( $theme['theme'] ) ? $theme['theme'] : '';
 
-                if ( get_stylesheet() !== $theme ) { // If not current.
+                // Only run if current theme
+                if ( get_stylesheet() !== $theme ) {
                         return $return;
                 }
@@ -582 +584 @@
                 }
 
-                // Time to remove maintenance mode.
+                // Time to remove maintenance mode. Bulk edit handles this separately.
                 if ( ! $this->bulk ) {
                         $this->maintenance_mode( false );