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

See #63166

git-svn-id: https://develop.svn.wordpress.org/trunk@60363 602fd350-edb4-49c9-b593-d223f7449a82

Author: johnbillion

src/wp-admin/install.php

@@ -233,9 +233,9 @@ function display_setup_form( $error = null ) {
 
 /**
  * @global string   $wp_version              The WordPress version string.
- * @global string   $required_php_version    The required PHP version string.
+ * @global string   $required_php_version    The minimum required PHP version string.
  * @global string[] $required_php_extensions The names of required PHP extensions.
- * @global string   $required_mysql_version  The required MySQL version string.
+ * @global string   $required_mysql_version  The minimum required MySQL version string.
  * @global wpdb     $wpdb                    WordPress database abstraction object.
  */
 global $wp_version, $required_php_version, $required_php_extensions, $required_mysql_version, $wpdb;

src/wp-admin/upgrade.php

@@ -37,9 +37,9 @@
 
 /**
  * @global string   $wp_version              The WordPress version string.
- * @global string   $required_php_version    The required PHP version string.
+ * @global string   $required_php_version    The minimum required PHP version string.
  * @global string[] $required_php_extensions The names of required PHP extensions.
- * @global string   $required_mysql_version  The required MySQL version string.
+ * @global string   $required_mysql_version  The minimum required MySQL version string.
  * @global wpdb     $wpdb                    WordPress database abstraction object.
  */
 global $wp_version, $required_php_version, $required_php_extensions, $required_mysql_version, $wpdb;

src/wp-includes/class-wpdb.php

@@ -43,7 +43,7 @@
  * By default, WordPress uses this class to instantiate the global $wpdb object, providing
  * 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.
  *
@@ -237,7 +237,6 @@ class wpdb {
 	 * WordPress table prefix.
 	 *
 	 * 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
 	 *
@@ -941,7 +940,7 @@ public function set_charset( $dbh, $charset = null, $collate = null ) {
 	/**
 	 * 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
 	 *
@@ -1369,7 +1368,7 @@ public function escape_by_ref( &$data ) {
 	}
 
 	/**
-	 * 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
 	 *
@@ -1435,6 +1434,13 @@ private function _escape_identifier_value( $identifier ) {
 	 *         'foo'
 	 *     );
 	 *
+	 *     $wpdb->prepare(
+	 *         "SELECT * FROM %i WHERE %i = %s",
+	 *         $table,
+	 *         $field,
+	 *         $value
+	 *     );
+	 *
 	 * @since 2.3.0
 	 * @since 5.3.0 Formalized the existing and already documented `...$args` parameter
 	 *              by updating the function signature. The second parameter was changed
@@ -1957,7 +1963,7 @@ public function db_connect( $allow_bail = true ) {
 		$client_flags = defined( 'MYSQL_CLIENT_FLAGS' ) ? MYSQL_CLIENT_FLAGS : 0;
 
 		/*
-		 * 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.
 		 */
@@ -2100,7 +2106,7 @@ public function parse_db_host( $host ) {
 		}
 
 		$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;
 
 		return array( $host, $port, $socket, $is_ipv6 );
@@ -2290,7 +2296,7 @@ public function query( $query ) {
 		if ( $this->dbh instanceof mysqli ) {
 			$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' );
 		}
 
 		if ( $this->last_error ) {
@@ -3473,7 +3479,7 @@ protected function check_ascii( $input_string ) {
 	}
 
 	/**
-	 * 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
 	 *
@@ -3987,11 +3993,11 @@ public function close() {
 	}
 
 	/**
-	 * 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
 	 */
 	public function check_database_version() {
@@ -4047,7 +4053,7 @@ public function get_charset_collate() {
 	 *
 	 * 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
 	 * developers to determine feature support. This is to account for drop-ins which may
@@ -4119,7 +4125,7 @@ public function get_caller() {
 	}
 
 	/**
-	 * Retrieves the database server version.
+	 * Retrieves the database server version number.
 	 *
 	 * @since 2.7.0
 	 *
@@ -4130,11 +4136,11 @@ public function db_version() {
 	}
 
 	/**
-	 * 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() {
 		return mysqli_get_server_info( $this->dbh );

src/wp-includes/load.php

@@ -139,15 +139,18 @@ function wp_populate_basic_auth_from_authorization_header() {
 }
 
 /**
- * Checks for the required PHP version, and the mysqli extension or
- * a database drop-in.
+ * Checks the server requirements.
+ *
+ *   - PHP version
+ *   - PHP extensions
+ *   - MySQL or MariaDB version (unless a database drop-in is present)
  *
  * Dies if requirements are not met.
  *
  * @since 3.0.0
  * @access private
  *
- * @global string   $required_php_version    The required PHP version string.
+ * @global string   $required_php_version    The minimum required PHP version string.
  * @global string[] $required_php_extensions The names of required PHP extensions.
  * @global string   $wp_version              The WordPress version string.
  */

src/wp-includes/version.php

@@ -33,7 +33,7 @@
 $tinymce_version = '49110-20201110';
 
 /**
- * Holds the required PHP version.
+ * Holds the minimum required PHP version.
  *
  * @global string $required_php_version
  */
@@ -50,7 +50,7 @@
 );
 
 /**
- * Holds the required MySQL version.
+ * Holds the minimum required MySQL version.
  *
  * @global string $required_mysql_version
  */

src/wp-settings.php

@@ -25,17 +25,17 @@
  * @global string   $wp_version              The WordPress version string.
  * @global int      $wp_db_version           WordPress database version.
  * @global string   $tinymce_version         TinyMCE version.
- * @global string   $required_php_version    The required PHP version string.
+ * @global string   $required_php_version    The minimum required PHP version string.
  * @global string[] $required_php_extensions The names of required PHP extensions.
- * @global string   $required_mysql_version  The required MySQL version string.
+ * @global string   $required_mysql_version  The minimum required MySQL version string.
  * @global string   $wp_local_package        Locale code of the package.
  */
 global $wp_version, $wp_db_version, $tinymce_version, $required_php_version, $required_php_extensions, $required_mysql_version, $wp_local_package;
 require ABSPATH . WPINC . '/version.php';
 require ABSPATH . WPINC . '/compat.php';
 require ABSPATH . WPINC . '/load.php';
 
-// Check for the required PHP version and for the MySQL extension or a database drop-in.
+// Check the server requirements.
 wp_check_php_mysql_versions();
 
 // Include files required for initialization.