Changeset 56180 for trunk/src/wp-includes/class-wpdb.php

Timestamp:

07/09/2023 09:46:24 PM (22 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.

Follow-up to [56174], [56175], [56176], [56177], [56178], [56179].

Props costdev, audrasjb.
See #58459.

File:

• trunk/src/wp-includes/class-wpdb.php (modified) (8 diffs)

trunk/src/wp-includes/class-wpdb.php

@@ -2156 +2156 @@
         }
 
-        // We need to check for an IPv6 address first.
-        // An IPv6 address will always contain at least two colons.
+        /*
+         * We need to check for an IPv6 address first.
+         * An IPv6 address will always contain at least two colons.
+         */
         if ( substr_count( $host, ':' ) > 1 ) {
             $pattern = '#^(?:\[)?(?P<host>[0-9a-fA-F:]+)(?:\]:(?P<port>[\d]+))?#';
@@ -2214 +2216 @@
 
         for ( $tries = 1; $tries <= $this->reconnect_retries; $tries++ ) {
-            // On the last try, re-enable warnings. We want to see a single instance
-            // of the "unable to connect" message on the bail() screen, if it appears.
+            /*
+             * On the last try, re-enable warnings. We want to see a single instance
+             * of the "unable to connect" message on the bail() screen, if it appears.
+             */
             if ( $this->reconnect_retries === $tries && WP_DEBUG ) {
                 error_reporting( $error_reporting );
@@ -2231 +2235 @@
         }
 
-        // If template_redirect has already happened, it's too late for wp_die()/dead_db().
-        // Let's just return and hope for the best.
+        /*
+         * If template_redirect has already happened, it's too late for wp_die()/dead_db().
+         * Let's just return and hope for the best.
+         */
         if ( did_action( 'template_redirect' ) ) {
             return false;
@@ -2265 +2271 @@
         $this->bail( $message, 'db_connect_fail' );
 
-        // Call dead_db() if bail didn't die, because this database is no more.
-        // It has ceased to be (at least temporarily).
+        /*
+         * Call dead_db() if bail didn't die, because this database is no more.
+         * It has ceased to be (at least temporarily).
+         */
         dead_db();
     }
@@ -2314 +2322 @@
         if ( $this->check_current_query && ! $this->check_ascii( $query ) ) {
             $stripped_query = $this->strip_invalid_text_from_query( $query );
-            // strip_invalid_text_from_query() can perform queries, so we need
-            // to flush again, just to make sure everything is clear.
+            /*
+             * strip_invalid_text_from_query() can perform queries, so we need
+             * to flush again, just to make sure everything is clear.
+             */
             $this->flush();
             if ( $stripped_query !== $query ) {
@@ -2343 +2353 @@
                     $mysql_errno = mysqli_errno( $this->dbh );
                 } else {
-                    // $dbh is defined, but isn't a real connection.
-                    // Something has gone horribly wrong, let's try a reconnect.
+                    /*
+                     * $dbh is defined, but isn't a real connection.
+                     * Something has gone horribly wrong, let's try a reconnect.
+                     */
                     $mysql_errno = 2006;
                 }
@@ -3123 +3135 @@
             return $this->last_result;
         } elseif ( OBJECT_K === $output ) {
-            // Return an array of row objects with keys from column 1.
-            // (Duplicates are discarded.)
+            /*
+             * Return an array of row objects with keys from column 1.
+             * (Duplicates are discarded.)
+             */
             if ( $this->last_result ) {
                 foreach ( $this->last_result as $row ) {
@@ -3530 +3544 @@
             } else {
                 $length = false;
-                // Since we have no length, we'll never truncate. Initialize the variable to false.
-                // True would take us through an unnecessary (for this case) codepath below.
+                /*
+                 * Since we have no length, we'll never truncate. Initialize the variable to false.
+                 * True would take us through an unnecessary (for this case) codepath below.
+                 */
                 $truncate_by_byte_length = false;
             }