Changeset 56174 for trunk/src/wp-admin/includes/file.php

Timestamp:

07/09/2023 07:50:52 PM (19 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/file.php (modified) (6 diffs)

trunk/src/wp-admin/includes/file.php

@@ -575 +575 @@
 
         if ( function_exists( 'session_status' ) && PHP_SESSION_ACTIVE === session_status() ) {
-            // Close any active session to prevent HTTP requests from timing out
-            // when attempting to connect back to the site.
+            /*
+             * Close any active session to prevent HTTP requests from timing out
+             * when attempting to connect back to the site.
+             */
             session_write_close();
         }
@@ -1252 +1254 @@
 
         if ( ! $signature ) {
-            // Retrieve signatures from a file if the header wasn't included.
-            // WordPress.org stores signatures at $package_url.sig.
+            /*
+             * Retrieve signatures from a file if the header wasn't included.
+             * WordPress.org stores signatures at $package_url.sig.
+             */
 
             $signature_url = false;
@@ -1387 +1391 @@
         extension_loaded( 'opcache' )
     ) {
-        // Sodium_Compat isn't compatible with PHP 7.2.0~7.2.2 due to a bug in the PHP Opcache extension, bail early as it'll fail.
-        // https://bugs.php.net/bug.php?id=75938
+        /*
+         * Sodium_Compat isn't compatible with PHP 7.2.0~7.2.2 due to a bug in the PHP Opcache extension, bail early as it'll fail.
+         * https://bugs.php.net/bug.php?id=75938
+         */
         return new WP_Error(
             'signature_verification_unsupported',
@@ -1421 +1427 @@
         }
 
-        // This cannot be performed in a reasonable amount of time.
-        // https://github.com/paragonie/sodium_compat#help-sodium_compat-is-slow-how-can-i-make-it-fast
+        /*
+         * This cannot be performed in a reasonable amount of time.
+         * https://github.com/paragonie/sodium_compat#help-sodium_compat-is-slow-how-can-i-make-it-fast
+         */
         if ( ! $sodium_compat_is_fast ) {
             return new WP_Error(
@@ -2328 +2336 @@
     );
 
-    // If defined, set it to that. Else, if POST'd, set it to that. If not, set it to an empty string.
-    // Otherwise, keep it as it previously was (saved details in option).
+    /*
+     * If defined, set it to that. Else, if POST'd, set it to that. If not, set it to an empty string.
+     * Otherwise, keep it as it previously was (saved details in option).
+     */
     foreach ( $ftp_constants as $key => $constant ) {
         if ( defined( $constant ) ) {
@@ -2532 +2542 @@
     }
 
-    // Make sure the `submit_button()` function is available during the REST API call
-    // from WP_Site_Health_Auto_Updates::test_check_wp_filesystem_method().
+    /*
+     * Make sure the `submit_button()` function is available during the REST API call
+     * from WP_Site_Health_Auto_Updates::test_check_wp_filesystem_method().
+     */
     if ( ! function_exists( 'submit_button' ) ) {
         require_once ABSPATH . 'wp-admin/includes/template.php';