Changeset 56174 for trunk/src/wp-admin/includes/class-wp-site-health.php

Timestamp:

07/09/2023 07:50:52 PM (3 years 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-site-health.php (modified) (5 diffs)

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -773 +773 @@
                 }
 
-                // The PHP version is still receiving security fixes, but is lower than
-                // the expected minimum version that will be required by WordPress in the near future.
+                /*
+                 * The PHP version is still receiving security fixes, but is lower than
+                 * the expected minimum version that will be required by WordPress in the near future.
+                 */
                 if ( $response['is_secure'] && $response['is_lower_than_future_minimum'] ) {
                         // The `is_secure` array key name doesn't actually imply this is a secure version of PHP. It only means it receives security updates.
@@ -1558 +1560 @@
          */
         public function get_test_https_status() {
-                // Enforce fresh HTTPS detection results. This is normally invoked by using cron,
-                // but for Site Health it should always rely on the latest results.
+                /*
+                 * Enforce fresh HTTPS detection results. This is normally invoked by using cron,
+                 * but for Site Health it should always rely on the latest results.
+                 */
                 wp_update_https_detection_errors();
 
@@ -1586 +1590 @@
 
                 if ( ! wp_is_using_https() ) {
-                        // If the website is not using HTTPS, provide more information
-                        // about whether it is supported and how it can be enabled.
+                        /*
+                         * If the website is not using HTTPS, provide more information
+                         * about whether it is supported and how it can be enabled.
+                         */
                         $result['status'] = 'recommended';
                         $result['label']  = __( 'Your website does not use HTTPS' );
@@ -1841 +1847 @@
                 }
 
-                // Run the auto-update tests in a separate class,
-                // as there are many considerations to be made.
+                /*
+                 * Run the auto-update tests in a separate class,
+                 * as there are many considerations to be made.
+                 */
                 $automatic_updates = new WP_Site_Health_Auto_Updates();
                 $tests             = $automatic_updates->run_tests();
@@ -3379 +3387 @@
                 $headers = array();
 
-                // Include basic auth in loopback requests. Note that this will only pass along basic auth when user is
-                // initiating the test. If a site requires basic auth, the test will fail when it runs in WP Cron as part of
-                // wp_site_health_scheduled_check. This logic is copied from WP_Site_Health::can_perform_loopback().
+                /*
+                 * Include basic auth in loopback requests. Note that this will only pass along basic auth when user is
+                 * initiating the test. If a site requires basic auth, the test will fail when it runs in WP Cron as part of
+                 * wp_site_health_scheduled_check. This logic is copied from WP_Site_Health::can_perform_loopback().
+                 */
                 if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {
                         $headers['Authorization'] = 'Basic ' . base64_encode( wp_unslash( $_SERVER['PHP_AUTH_USER'] ) . ':' . wp_unslash( $_SERVER['PHP_AUTH_PW'] ) );