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

Timestamp:

06/29/2025 08:53:29 PM (15 months ago)

Author:

johnbillion

Message:

Docs: Documentation and i18n string improvements relating to MySQL and server requirements.

See #63166

File:

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

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

@@ -44 +44 @@
  * access to the WordPress database.
  *
- * It is possible to replace this class with your own by setting the $wpdb global variable
+ * It is possible to replace the global instance with your own by setting the $wpdb global variable
  * in wp-content/db.php file to your class. The wpdb class will still be included, so you can
  * extend it or simply use your own.
@@ -238 +238 @@
          *
          * You can set this to have multiple WordPress installations in a single database.
-         * The second reason is for possible security precautions.
          *
          * @since 2.5.0
@@ -942 +941 @@
          * Changes the current SQL mode, and ensures its WordPress compatibility.
          *
-         * If no modes are passed, it will ensure the current MySQL server modes are compatible.
+         * If no modes are passed, it will ensure the current SQL server modes are compatible.
          *
          * @since 3.9.0
@@ -1370 +1369 @@
 
         /**
-         * Quotes an identifier for a MySQL database, e.g. table/field names.
+         * Quotes an identifier such as a table or field name.
          *
          * @since 6.2.0
@@ -1434 +1433 @@
          *         "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s",
          *         'foo'
+         *     );
+         *
+         *     $wpdb->prepare(
+         *         "SELECT * FROM %i WHERE %i = %s",
+         *         $table,
+         *         $field,
+         *         $value
          *     );
          *
@@ -1958 +1964 @@
 
                 /*
-                 * Set the MySQLi error reporting off because WordPress handles its own.
+                 * Switch error reporting off because WordPress handles its own.
                  * This is due to the default value change from `MYSQLI_REPORT_OFF`
                  * to `MYSQLI_REPORT_ERROR|MYSQLI_REPORT_STRICT` in PHP 8.1.
@@ -2101 +2107 @@
 
                 $host = ! empty( $matches['host'] ) ? $matches['host'] : '';
-                // MySQLi port cannot be a string; must be null or an integer.
+                // Port cannot be a string; must be null or an integer.
                 $port = ! empty( $matches['port'] ) ? absint( $matches['port'] ) : null;
 
@@ -2291 +2297 @@
                         $this->last_error = mysqli_error( $this->dbh );
                 } else {
-                        $this->last_error = __( 'Unable to retrieve the error message from MySQL' );
+                        $this->last_error = __( 'Unable to retrieve the error message from the database server' );
                 }
 
@@ -3474 +3480 @@
 
         /**
-         * Checks if the query is accessing a collation considered safe on the current version of MySQL.
+         * Checks if the query is accessing a collation considered safe.
          *
          * @since 4.2.0
@@ -3988 +3994 @@
 
         /**
-         * Determines whether MySQL database is at least the required minimum version.
+         * Determines whether the database server is at least the required minimum version.
          *
          * @since 2.5.0
          *
-         * @global string $required_mysql_version The required MySQL version string.
+         * @global string $required_mysql_version The minimum required MySQL version string.
          * @return void|WP_Error
          */
@@ -4048 +4054 @@
          * Capability sniffs for the database server and current version of WPDB.
          *
-         * Database sniffs are based on the version of MySQL the site is using.
+         * Database sniffs are based on the version of the database server in use.
          *
          * WPDB sniffs are added as new features are introduced to allow theme and plugin
@@ -4120 +4126 @@
 
         /**
-         * Retrieves the database server version.
+         * Retrieves the database server version number.
          *
          * @since 2.7.0
@@ -4131 +4137 @@
 
         /**
-         * Returns the version of the MySQL server.
+         * Returns the raw version string of the database server.
          *
          * @since 5.5.0
          *
-         * @return string Server version as a string.
+         * @return string Database server version as a string.
          */
         public function db_server_info() {