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

Timestamp:

07/09/2023 07:50:52 PM (17 months ago)

Author:

audrasjb

Message:

Docs: Replace multiple single line comments with multi-line comments.

This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See ​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.

Props costdev, audrasjb.
See #58459.

File:

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

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

@@ -471 +471 @@
                     || 'locked' === $upgrade_result->get_error_code() )
             ) {
-                // These aren't actual errors, treat it as a skipped-update instead
-                // to avoid triggering the post-core update failure routines.
+                /*
+                 * These aren't actual errors, treat it as a skipped-update instead
+                 * to avoid triggering the post-core update failure routines.
+                 */
                 return false;
             }
@@ -549 +551 @@
         }
 
-        // 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'] ) ) {
@@ -639 +643 @@
         $error_code = $result->get_error_code();
 
-        // Any of these WP_Error codes are critical failures, as in they occurred after we started to copy core files.
-        // We should not try to perform a background update again until there is a successful one-click update performed by the user.
+        /*
+         * Any of these WP_Error codes are critical failures, as in they occurred after we started to copy core files.
+         * We should not try to perform a background update again until there is a successful one-click update performed by the user.
+         */
         $critical = false;
         if ( 'disk_full' === $error_code || str_contains( $error_code, '__copy_dir' ) ) {
@@ -832 +838 @@
                 $body .= "\n\n";
 
-                // Don't show this message if there is a newer version available.
-                // Potential for confusion, and also not useful for them to know at this point.
+                /*
+                 * Don't show this message if there is a newer version available.
+                 * Potential for confusion, and also not useful for them to know at this point.
+                 */
                 if ( 'fail' === $type && ! $newer_version_available ) {
                     $body .= __( 'An attempt was made, but your site could not be updated automatically.' ) . ' ';
@@ -904 +912 @@
             $body .= ' ' . __( 'Your hosting company, support forum volunteers, or a friendly developer may be able to use this information to help you:' );
 
-            // If we had a rollback and we're still critical, then the rollback failed too.
-            // Loop through all errors (the main WP_Error, the update result, the rollback result) for code, data, etc.
+            /*
+             * If we had a rollback and we're still critical, then the rollback failed too.
+             * Loop through all errors (the main WP_Error, the update result, the rollback result) for code, data, etc.
+             */
             if ( 'rollback_was_required' === $result->get_error_code() ) {
                 $errors = array( $result, $result->get_error_data()->update, $result->get_error_data()->rollback );