enmi-conf.org: comparison wp/wp-includes/wp-db.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 <?php
 /**
-* WordPress DB Class
+* WordPress database access abstraction class
 *
 * Original code from {@link http://php.justinvincent.com Justin Vincent (justin@visunet.ie)}
 *
 * @package WordPress
 * @subpackage Database
 * @since 0.71
 */
 define( 'ARRAY_N', 'ARRAY_N' );
 /**
-* WordPress Database Access Abstraction Object
+* WordPress database access abstraction class.
 *
-* It is possible to replace this class with your own
+* This class is used to interact with a database without needing to use raw SQL statements.
-* by setting the $wpdb global variable in wp-content/db.php
+* By default, WordPress uses this class to instantiate the global $wpdb object, providing
-* file to your class. The wpdb class will still be included,
+* access to the WordPress database.
-* so you can extend it or simply use your own.
 *
-* @link https://codex.wordpress.org/Function_Reference/wpdb_Class
+* It is possible to replace this class 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.
+*
+* @link https://developer.wordpress.org/reference/classes/wpdb/
 *
 * @since 0.71
 */
 class wpdb {
 	/**
 	 * Whether to show SQL/DB errors.
 	 *
-	 * Default behavior is to show errors if both WP_DEBUG and WP_DEBUG_DISPLAY
+	 * Default is to show errors if both WP_DEBUG and WP_DEBUG_DISPLAY evaluate to true.
-	 * evaluated to true.
 	 *
 	 * @since 0.71
 	 * @var bool
 	 */
 	var $show_errors = false;
 	/**
-	 * Whether to suppress errors during the DB bootstrapping.
+	 * Whether to suppress errors during the DB bootstrapping. Default false.
 	 *
 	 * @since 2.5.0
 	 * @var bool
 	 */
 	var $suppress_errors = false;
 	/**
-	 * The last error during query.
+	 * The error encountered during the last query.
 	 *
 	 * @since 2.5.0
 	 * @var string
 	 */
 	public $last_error = '';
 	/**
-	 * Amount of queries made
+	 * The number of queries made.
 	 *
 	 * @since 1.2.0
 	 * @var int
 	 */
 	public $num_queries = 0;
 	/**
-	 * Count of rows returned by previous query
+	 * Count of rows returned by the last query.
 	 *
 	 * @since 0.71
 	 * @var int
 	 */
 	public $num_rows = 0;
 	/**
-	 * Count of affected rows by previous query
+	 * Count of rows affected by the last query.
 	 *
 	 * @since 0.71
 	 * @var int
 	 */
 	var $rows_affected = 0;
 	/**
-	 * The ID generated for an AUTO_INCREMENT column by the previous query (usually INSERT).
+	 * The ID generated for an AUTO_INCREMENT column by the last query (usually INSERT).
 	 *
 	 * @since 0.71
 	 * @var int
 	 */
 	public $insert_id = 0;
 	/**
-	 * Last query made
+	 * The last query made.
 	 *
 	 * @since 0.71
-	 * @var array
+	 * @var string
 	 */
 	var $last_query;
 	/**
-	 * Results of the last query made
+	 * Results of the last query.
 	 *
 	 * @since 0.71
 	 * @var array|null
 	 */
 	var $last_result;
 	 * @var mixed
 	 */
 	protected $result;
 	/**
-	 * Cached column info, for sanity checking data before inserting
+	 * Cached column info, for sanity checking data before inserting.
 	 *
 	 * @since 4.2.0
 	 * @var array
 	 */
 	protected $col_meta = array();
 	/**
-	 * Calculated character sets on tables
+	 * Calculated character sets on tables.
 	 *
 	 * @since 4.2.0
 	 * @var array
 	 */
 	protected $table_charset = array();
 	/**
-	 * Whether text fields in the current query need to be sanity checked.
+	 * Whether text fields in the current query need to be sanity checked. Default false.
 	 *
 	 * @since 4.2.0
 	 * @var bool
 	 */
 	protected $check_current_query = true;
 	 * @var bool
 	 */
 	private $checking_collation = false;
 	/**
-	 * Saved info on the table column
+	 * Saved info on the table column.
 	 *
 	 * @since 0.71
 	 * @var array
 	 */
 	protected $col_info;
 	 * Log of queries that were executed, for debugging purposes.
 	 *
 	 * @since 1.5.0
 	 * @since 2.5.0 The third element in each query log was added to record the calling functions.
 	 * @since 5.1.0 The fourth element in each query log was added to record the start time.
+	 * @since 5.3.0 The fifth element in each query log was added to record custom data.
 	 *
 	 * @var array[] {
 	 *     Array of queries that were executed.
 	 *
 	 *     @type array ...$0 {
 	 *         Data for each query.
 	 *
 	 *         @type string $0 The query's SQL.
 	 *         @type float  $1 Total time spent on the query, in seconds.
-	 *         @type string $2 Comma separated list of the calling functions.
+	 *         @type string $2 Comma-separated list of the calling functions.
 	 *         @type float  $3 Unix timestamp of the time at the start of the query.
+	 *         @type array  $4 Custom query data.
 	 *     }
 	 * }
 	 */
 	var $queries;
 	/**
-	 * The number of times to retry reconnecting before dying.
+	 * The number of times to retry reconnecting before dying. Default 5.
 	 *
 	 * @since 3.9.0
 	 * @see wpdb::check_connection()
 	 * @var int
 	 */
 	protected $reconnect_retries = 5;
 	/**
 	 * WordPress table prefix
 	 *
-	 * You can set this to have multiple WordPress installations
+	 * You can set this to have multiple WordPress installations in a single database.
-	 * in a single database. The second reason is for possible
+	 * The second reason is for possible security precautions.
-	 * security precautions.
 	 *
 	 * @since 2.5.0
 	 * @var string
 	 */
 	public $prefix = '';
 	 * @var int
 	 */
 	public $siteid = 0;
 	/**
-	 * List of WordPress per-blog tables
+	 * List of WordPress per-blog tables.
 	 *
 	 * @since 2.5.0
 	 * @see wpdb::tables()
 	 * @var array
 	 */
 		'termmeta',
 		'commentmeta',
 	);
 	/**
-	 * List of deprecated WordPress tables
+	 * List of deprecated WordPress tables.
 	 *
-	 * categories, post2cat, and link2cat were deprecated in 2.3.0, db version 5539
+	 * 'categories', 'post2cat', and 'link2cat' were deprecated in 2.3.0, db version 5539.
 	 *
 	 * @since 2.9.0
 	 * @see wpdb::tables()
 	 * @var array
 	 */
 	var $old_tables = array( 'categories', 'post2cat', 'link2cat' );
 	/**
-	 * List of WordPress global tables
+	 * List of WordPress global tables.
 	 *
 	 * @since 3.0.0
 	 * @see wpdb::tables()
 	 * @var array
 	 */
 	var $global_tables = array( 'users', 'usermeta' );
 	/**
-	 * List of Multisite global tables
+	 * List of Multisite global tables.
 	 *
 	 * @since 3.0.0
 	 * @see wpdb::tables()
 	 * @var array
 	 */
 		'signups',
 		'site',
 		'sitemeta',
 		'sitecategories',
 		'registration_log',
-		'blog_versions',
 	);
 	/**
-	 * WordPress Comments table
+	 * WordPress Comments table.
 	 *
 	 * @since 1.5.0
 	 * @var string
 	 */
 	public $comments;
 	/**
-	 * WordPress Comment Metadata table
+	 * WordPress Comment Metadata table.
 	 *
 	 * @since 2.9.0
 	 * @var string
 	 */
 	public $commentmeta;
 	/**
-	 * WordPress Links table
+	 * WordPress Links table.
 	 *
 	 * @since 1.5.0
 	 * @var string
 	 */
 	public $links;
 	/**
-	 * WordPress Options table
+	 * WordPress Options table.
 	 *
 	 * @since 1.5.0
 	 * @var string
 	 */
 	public $options;
 	/**
-	 * WordPress Post Metadata table
+	 * WordPress Post Metadata table.
 	 *
 	 * @since 1.5.0
 	 * @var string
 	 */
 	public $postmeta;
 	/**
-	 * WordPress Posts table
+	 * WordPress Posts table.
 	 *
 	 * @since 1.5.0
 	 * @var string
 	 */
 	public $posts;
 	/**
-	 * WordPress Terms table
+	 * WordPress Terms table.
 	 *
 	 * @since 2.3.0
 	 * @var string
 	 */
 	public $terms;
 	/**
-	 * WordPress Term Relationships table
+	 * WordPress Term Relationships table.
 	 *
 	 * @since 2.3.0
 	 * @var string
 	 */
 	public $term_relationships;
 	/**
-	 * WordPress Term Taxonomy table
+	 * WordPress Term Taxonomy table.
 	 *
 	 * @since 2.3.0
 	 * @var string
 	 */
 	public $term_taxonomy;
 	//
 	// Global and Multisite tables
 	//
 	/**
-	 * WordPress User Metadata table
+	 * WordPress User Metadata table.
 	 *
 	 * @since 2.3.0
 	 * @var string
 	 */
 	public $usermeta;
 	/**
-	 * WordPress Users table
+	 * WordPress Users table.
 	 *
 	 * @since 1.5.0
 	 * @var string
 	 */
 	public $users;
 	/**
-	 * Multisite Blogs table
+	 * Multisite Blogs table.
 	 *
 	 * @since 3.0.0
 	 * @var string
 	 */
 	public $blogs;
 	/**
-	 * Multisite Blog Metadata table
+	 * Multisite Blog Metadata table.
 	 *
 	 * @since 5.1.0
 	 * @var string
 	 */
 	public $blogmeta;
 	/**
-	 * Multisite Blog Versions table
+	 * Multisite Registration Log table.
 	 *
 	 * @since 3.0.0
 	 * @var string
 	 */
-	public $blog_versions;
+	public $registration_log;
 	/**
-	 * Multisite Registration Log table
+	 * Multisite Signups table.
 	 *
 	 * @since 3.0.0
 	 * @var string
 	 */
-	public $registration_log;
+	public $signups;
 	/**
-	 * Multisite Signups table
+	 * Multisite Sites table.
 	 *
 	 * @since 3.0.0
 	 * @var string
 	 */
-	public $signups;
+	public $site;
 	/**
-	 * Multisite Sites table
+	 * Multisite Sitewide Terms table.
 	 *
 	 * @since 3.0.0
 	 * @var string
 	 */
-	public $site;
+	public $sitecategories;
 	/**
-	 * Multisite Sitewide Terms table
+	 * Multisite Site Metadata table.
 	 *
 	 * @since 3.0.0
 	 * @var string
 	 */
-	public $sitecategories;
-	/**
-	 * Multisite Site Metadata table
-	 *
-	 * @since 3.0.0
-	 * @var string
-	 */
 	public $sitemeta;
 	/**
-	 * Format specifiers for DB columns. Columns not listed here default to %s. Initialized during WP load.
+	 * Format specifiers for DB columns.
 	 *
-	 * Keys are column names, values are format types: 'ID' => '%d'
+	 * Columns not listed here default to %s. Initialized during WP load.
+	 * Keys are column names, values are format types: 'ID' => '%d'.
 	 *
 	 * @since 2.8.0
 	 * @see wpdb::prepare()
 	 * @see wpdb::insert()
 	 * @see wpdb::update()
 	 * @var array
 	 */
 	public $field_types = array();
 	/**
-	 * Database table columns charset
+	 * Database table columns charset.
 	 *
 	 * @since 2.2.0
 	 * @var string
 	 */
 	public $charset;
 	/**
-	 * Database table columns collate
+	 * Database table columns collate.
 	 *
 	 * @since 2.2.0
 	 * @var string
 	 */
 	public $collate;
 	/**
-	 * Database Username
+	 * Database Username.
 	 *
 	 * @since 2.9.0
 	 * @var string
 	 */
 	protected $dbuser;
 	/**
-	 * Database Password
+	 * Database Password.
 	 *
 	 * @since 3.1.0
 	 * @var string
 	 */
 	protected $dbpassword;
 	/**
-	 * Database Name
+	 * Database Name.
 	 *
 	 * @since 3.1.0
 	 * @var string
 	 */
 	protected $dbname;
 	/**
-	 * Database Host
+	 * Database Host.
 	 *
 	 * @since 3.1.0
 	 * @var string
 	 */
 	protected $dbhost;
 	/**
-	 * Database Handle
+	 * Database Handle.
 	 *
 	 * @since 0.71
 	 * @var string
 	 */
 	protected $dbh;
 	/**
-	 * A textual description of the last query/get_row/get_var call
+	 * A textual description of the last query/get_row/get_var call.
 	 *
 	 * @since 3.0.0
 	 * @var string
 	 */
 	public $func_call;
 	/**
 	 * Whether MySQL is used as the database engine.
 	 *
-	 * Set in WPDB::db_connect() to true, by default. This is used when checking
+	 * Set in wpdb::db_connect() to true, by default. This is used when checking
 	 * against the required MySQL version for WordPress. Normally, a replacement
 	 * database drop-in (db.php) will skip these checks, but setting this to true
 	 * will force the checks to occur.
 	 *
 	 * @since 3.3.0
 		'NO_ZERO_DATE',
 		'ONLY_FULL_GROUP_BY',
 		'STRICT_TRANS_TABLES',
 		'STRICT_ALL_TABLES',
 		'TRADITIONAL',
+		'ANSI',
 	);
 	/**
-	 * Whether to use mysqli over mysql.
+	 * Whether to use mysqli over mysql. Default false.
 	 *
 	 * @since 3.9.0
 	 * @var bool
 	 */
 	private $use_mysqli = false;
 	/**
-	 * Whether we've managed to successfully connect at some point
+	 * Whether we've managed to successfully connect at some point.
 	 *
 	 * @since 3.9.0
 	 * @var bool
 	 */
 	private $has_connected = false;
 	/**
-	 * Connects to the database server and selects a database
+	 * Connects to the database server and selects a database.
 	 *
-	 * PHP5 style constructor for compatibility with PHP5. Does
+	 * PHP5 style constructor for compatibility with PHP5. Does the actual setting up
-	 * the actual setting up of the class properties and connection
+	 * of the class properties and connection to the database.
-	 * to the database.
+	 *
+	 * @since 2.0.8
 	 *
 	 * @link https://core.trac.wordpress.org/ticket/3354
-	 * @since 2.0.8
+	 * @global string $wp_version The WordPress version string.
 	 *
-	 * @global string $wp_version
+	 * @param string $dbuser     MySQL database user.
-	 *
+	 * @param string $dbpassword MySQL database password.
-	 * @param string $dbuser     MySQL database user
+	 * @param string $dbname     MySQL database name.
-	 * @param string $dbpassword MySQL database password
+	 * @param string $dbhost     MySQL database host.
-	 * @param string $dbname     MySQL database name
-	 * @param string $dbhost     MySQL database host
 	 */
 	public function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) {
-		register_shutdown_function( array( $this, '__destruct' ) );
 		if ( WP_DEBUG && WP_DEBUG_DISPLAY ) {
 			$this->show_errors();
 		}
-		// Use ext/mysqli if it exists unless WP_USE_EXT_MYSQL is defined as true
+		// Use ext/mysqli if it exists unless WP_USE_EXT_MYSQL is defined as true.
 		if ( function_exists( 'mysqli_connect' ) ) {
 			$this->use_mysqli = true;
 			if ( defined( 'WP_USE_EXT_MYSQL' ) ) {
 				$this->use_mysqli = ! WP_USE_EXT_MYSQL;
 		$this->db_connect();
 	}
 	/**
-	 * PHP5 style destructor and will run when database object is destroyed.
-	 *
-	 * @see wpdb::__construct()
-	 * @since 2.0.8
-	 * @return true
-	 */
-	public function __destruct() {
-		return true;
-	}
-	/**
 	 * Makes private properties readable for backward compatibility.
 	 *
 	 * @since 3.5.0
 	 *
-	 * @param string $name The private member to get, and optionally process
+	 * @param string $name The private member to get, and optionally process.
-	 * @return mixed The private member
+	 * @return mixed The private member.
 	 */
 	public function __get( $name ) {
 		if ( 'col_info' === $name ) {
 			$this->load_col_info();
 		}
 	/**
 	 * Makes private properties settable for backward compatibility.
 	 *
 	 * @since 3.5.0
 	 *
-	 * @param string $name  The private member to set
+	 * @param string $name  The private member to set.
-	 * @param mixed  $value The value to set
+	 * @param mixed  $value The value to set.
 	 */
 	public function __set( $name, $value ) {
 		$protected_members = array(
 			'col_meta',
 			'table_charset',
 	/**
 	 * Makes private properties check-able for backward compatibility.
 	 *
 	 * @since 3.5.0
 	 *
-	 * @param string $name  The private member to check
+	 * @param string $name The private member to check.
-	 *
+	 * @return bool If the member is set or not.
-	 * @return bool If the member is set or not
 	 */
 	public function __isset( $name ) {
 		return isset( $this->$name );
 	}
 	public function __unset( $name ) {
 		unset( $this->$name );
 	}
 	/**
-	 * Set $this->charset and $this->collate
+	 * Sets $this->charset and $this->collate.
 	 *
 	 * @since 3.1.0
 	 */
 	public function init_charset() {
 		$charset = '';
 	 *
 	 * @since 4.6.0
 	 *
 	 * @param string $charset The character set to check.
 	 * @param string $collate The collation to check.
-	 * @return array The most appropriate character set and collation to use.
+	 * @return array {
+	 *     The most appropriate character set and collation to use.
+	 *
+	 *     @type string $charset Character set.
+	 *     @type string $collate Collation.
+	 * }
 	 */
 	public function determine_charset( $charset, $collate ) {
 		if ( ( $this->use_mysqli && ! ( $this->dbh instanceof mysqli ) ) || empty( $this->dbh ) ) {
 			return compact( 'charset', 'collate' );
 		}
 	/**
 	 * Sets the connection's character set.
 	 *
 	 * @since 3.1.0
 	 *
-	 * @param resource $dbh     The resource given by mysql_connect
+	 * @param resource $dbh     The resource given by mysql_connect.
 	 * @param string   $charset Optional. The character set. Default null.
 	 * @param string   $collate Optional. The collation. Default null.
 	 */
 	public function set_charset( $dbh, $charset = null, $collate = null ) {
 		if ( ! isset( $charset ) ) {
 			}
 		}
 	}
 	/**
-	 * Change the current SQL mode, and ensure its WordPress compatibility.
+	 * Changes the current SQL mode, and ensures its WordPress compatibility.
 	 *
-	 * If no modes are passed, it will ensure the current MySQL server
+	 * If no modes are passed, it will ensure the current MySQL server modes are compatible.
-	 * modes are compatible.
 	 *
 	 * @since 3.9.0
 	 *
-	 * @param array $modes Optional. A list of SQL modes to set.
+	 * @param array $modes Optional. A list of SQL modes to set. Default empty array.
 	 */
 	public function set_sql_mode( $modes = array() ) {
 		if ( empty( $modes ) ) {
 			if ( $this->use_mysqli ) {
 				$res = mysqli_query( $this->dbh, 'SELECT @@SESSION.sql_mode' );
 		 * @param array $incompatible_modes An array of incompatible modes.
 		 */
 		$incompatible_modes = (array) apply_filters( 'incompatible_sql_modes', $this->incompatible_modes );
 		foreach ( $modes as $i => $mode ) {
-			if ( in_array( $mode, $incompatible_modes ) ) {
+			if ( in_array( $mode, $incompatible_modes, true ) ) {
 				unset( $modes[ $i ] );
 			}
 		}
 		$modes_str = implode( ',', $modes );
 	 * Sets the table prefix for the WordPress tables.
 	 *
 	 * @since 2.5.0
 	 *
 	 * @param string $prefix          Alphanumeric name for the new prefix.
-	 * @param bool   $set_table_names Optional. Whether the table names, e.g. wpdb::$posts, should be updated or not.
+	 * @param bool   $set_table_names Optional. Whether the table names, e.g. wpdb::$posts,
-	 * @return string|WP_Error Old prefix or WP_Error on error
+	 *                                should be updated or not. Default true.
+	 * @return string|WP_Error Old prefix or WP_Error on error.
 	 */
 	public function set_prefix( $prefix, $set_table_names = true ) {
 		if ( preg_match( '|[^a-z0-9_]|i', $prefix ) ) {
 			return new WP_Error( 'invalid_db_prefix', 'Invalid database prefix' );
 		}
 		return $old_prefix;
 	}
 	/**
-	 * Sets blog id.
+	 * Sets blog ID.
 	 *
 	 * @since 3.0.0
 	 *
 	 * @param int $blog_id
 	 * @param int $network_id Optional.
-	 * @return int previous blog id
+	 * @return int Previous blog ID.
 	 */
 	public function set_blog_id( $blog_id, $network_id = 0 ) {
 		if ( ! empty( $network_id ) ) {
 			$this->siteid = $network_id;
 		}
 	/**
 	 * Gets blog prefix.
 	 *
 	 * @since 3.0.0
+	 *
 	 * @param int $blog_id Optional.
 	 * @return string Blog prefix.
 	 */
 	public function get_blog_prefix( $blog_id = null ) {
 		if ( is_multisite() ) {
 			if ( null === $blog_id ) {
 				$blog_id = $this->blogid;
 			}
 			$blog_id = (int) $blog_id;
-			if ( defined( 'MULTISITE' ) && ( 0 == $blog_id || 1 == $blog_id ) ) {
+			if ( defined( 'MULTISITE' ) && ( 0 === $blog_id || 1 === $blog_id ) ) {
 				return $this->base_prefix;
 			} else {
 				return $this->base_prefix . $blog_id . '_';
 			}
 		} else {
 	}
 	/**
 	 * Returns an array of WordPress tables.
 	 *
-	 * Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
+	 * Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to override the WordPress users
-	 * override the WordPress users and usermeta tables that would otherwise
+	 * and usermeta tables that would otherwise be determined by the prefix.
-	 * be determined by the prefix.
+	 *
-	 *
+	 * The $scope argument can take one of the following:
-	 * The scope argument can take one of the following:
 	 *
 	 * 'all' - returns 'all' and 'global' tables. No old tables are returned.
 	 * 'blog' - returns the blog-level tables for the queried blog.
-	 * 'global' - returns the global tables for the installation, returning multisite tables only if running multisite.
+	 * 'global' - returns the global tables for the installation, returning multisite tables only on multisite.
 	 * 'ms_global' - returns the multisite global tables, regardless if current installation is multisite.
 	 * 'old' - returns tables which are deprecated.
 	 *
 	 * @since 3.0.0
+	 *
 	 * @uses wpdb::$tables
 	 * @uses wpdb::$old_tables
 	 * @uses wpdb::$global_tables
 	 * @uses wpdb::$ms_global_tables
 	 *
-	 * @param string $scope   Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all.
+	 * @param string $scope   Optional. Possible values include 'all', 'global', 'ms_global', 'blog',
-	 * @param bool   $prefix  Optional. Whether to include table prefixes. Default true. If blog
+	 *                        or 'old' tables. Default 'all'.
-	 *                        prefix is requested, then the custom users and usermeta tables will be mapped.
+	 * @param bool   $prefix  Optional. Whether to include table prefixes. If blog prefix is requested,
-	 * @param int    $blog_id Optional. The blog_id to prefix. Defaults to wpdb::$blogid. Used only when prefix is requested.
+	 *                        then the custom users and usermeta tables will be mapped. Default true.
+	 * @param int    $blog_id Optional. The blog_id to prefix. Used only when prefix is requested.
+	 *                        Defaults to wpdb::$blogid.
 	 * @return array Table names. When a prefix is requested, the key is the unprefixed table name.
 	 */
 	public function tables( $scope = 'all', $prefix = true, $blog_id = 0 ) {
 		switch ( $scope ) {
 			case 'all':
 			}
 			$blog_prefix   = $this->get_blog_prefix( $blog_id );
 			$base_prefix   = $this->base_prefix;
 			$global_tables = array_merge( $this->global_tables, $this->ms_global_tables );
 			foreach ( $tables as $k => $table ) {
-				if ( in_array( $table, $global_tables ) ) {
+				if ( in_array( $table, $global_tables, true ) ) {
 					$tables[ $table ] = $base_prefix . $table;
 				} else {
 					$tables[ $table ] = $blog_prefix . $table;
 				}
 				unset( $tables[ $k ] );
 	}
 	/**
 	 * Selects a database using the current database connection.
 	 *
-	 * The database name will be changed based on the current database
+	 * The database name will be changed based on the current database connection.
-	 * connection. On failure, the execution will bail and display an DB error.
+	 * On failure, the execution will bail and display a DB error.
 	 *
 	 * @since 0.71
 	 *
-	 * @param string        $db  MySQL database name
+	 * @param string        $db  MySQL database name.
 	 * @param resource|null $dbh Optional link identifier.
 	 */
 	public function select( $db, $dbh = null ) {
 		if ( is_null( $dbh ) ) {
 			$dbh = $this->dbh;
 				wp_load_translations_early();
 				$message = '<h1>' . __( 'Can&#8217;t select database' ) . "</h1>\n";
 				$message .= '<p>' . sprintf(
-					/* translators: %s: database name */
+					/* translators: %s: Database name. */
 					__( 'We were able to connect to the database server (which means your username and password is okay) but not able to select the %s database.' ),
 					'<code>' . htmlspecialchars( $db, ENT_QUOTES ) . '</code>'
 				) . "</p>\n";
 				$message .= "<ul>\n";
 				$message .= '<li>' . __( 'Are you sure it exists?' ) . "</li>\n";
 				$message .= '<li>' . sprintf(
-					/* translators: 1: database user, 2: database name */
+					/* translators: 1: Database user, 2: Database name. */
 					__( 'Does the user %1$s have permission to use the %2$s database?' ),
 					'<code>' . htmlspecialchars( $this->dbuser, ENT_QUOTES ) . '</code>',
 					'<code>' . htmlspecialchars( $db, ENT_QUOTES ) . '</code>'
 				) . "</li>\n";
 				$message .= '<li>' . sprintf(
-					/* translators: %s: database name */
+					/* translators: %s: Database name. */
 					__( 'On some systems the name of your database is prefixed with your username, so it would be like <code>username_%1$s</code>. Could that be the problem?' ),
 					htmlspecialchars( $db, ENT_QUOTES )
 				) . "</li>\n";
 				$message .= "</ul>\n";
 				$message .= '<p>' . sprintf(
-					/* translators: %s: support forums URL */
+					/* translators: %s: Support forums URL. */
 					__( 'If you don&#8217;t know how to set up a database you should <strong>contact your host</strong>. If all else fails you may find help at the <a href="%s">WordPress Support Forums</a>.' ),
 					__( 'https://wordpress.org/support/forums/' )
 				) . "</p>\n";
 				$this->bail( $message, 'db_select_fail' );
 	 *
 	 * Use esc_sql() or wpdb::prepare() instead.
 	 *
 	 * @since 2.8.0
 	 * @deprecated 3.6.0 Use wpdb::prepare()
-	 * @see wpdb::prepare
+	 * @see wpdb::prepare()
 	 * @see esc_sql()
 	 *
 	 * @param string $string
 	 * @return string
 	 */
 		}
 		return addslashes( $string );
 	}
 	/**
-	 * Real escape, using mysqli_real_escape_string() or mysql_real_escape_string()
+	 * Real escape, using mysqli_real_escape_string() or mysql_real_escape_string().
+	 *
+	 * @since 2.8.0
 	 *
 	 * @see mysqli_real_escape_string()
 	 * @see mysql_real_escape_string()
-	 * @since 2.8.0
+	 *
-	 *
+	 * @param string $string String to escape.
-	 * @param  string $string to escape
+	 * @return string Escaped string.
-	 * @return string escaped
 	 */
 	function _real_escape( $string ) {
 		if ( $this->dbh ) {
 			if ( $this->use_mysqli ) {
 				$escaped = mysqli_real_escape_string( $this->dbh, $string );
 				$escaped = mysql_real_escape_string( $string, $this->dbh );
 			}
 		} else {
 			$class = get_class( $this );
 			if ( function_exists( '__' ) ) {
-				/* translators: %s: database access abstraction class, usually wpdb or a class extending wpdb */
+				/* translators: %s: Database access abstraction class, usually wpdb or a class extending wpdb. */
 				_doing_it_wrong( $class, sprintf( __( '%s must set a database connection for use with escaping.' ), $class ), '3.6.0' );
 			} else {
 				_doing_it_wrong( $class, sprintf( '%s must set a database connection for use with escaping.', $class ), '3.6.0' );
 			}
 			$escaped = addslashes( $string );
 		return $this->add_placeholder_escape( $escaped );
 	}
 	/**
-	 * Escape data. Works on arrays.
+	 * Escapes data. Works on arrays.
+	 *
+	 * @since 2.8.0
 	 *
 	 * @uses wpdb::_real_escape()
-	 * @since  2.8.0
+	 *
-	 *
+	 * @param string|array $data Data to escape.
-	 * @param  string|array $data
+	 * @return string|array Escaped data, in the same type as supplied.
-	 * @return string|array escaped
 	 */
 	public function _escape( $data ) {
 		if ( is_array( $data ) ) {
 			foreach ( $data as $k => $v ) {
 				if ( is_array( $v ) ) {
 	 * @since 0.71
 	 * @deprecated 3.6.0 Use wpdb::prepare()
 	 * @see wpdb::prepare()
 	 * @see esc_sql()
 	 *
-	 * @param mixed $data
+	 * @param string|array $data Data to escape.
-	 * @return mixed
+	 * @return string|array Escaped data, in the same type as supplied.
 	 */
 	public function escape( $data ) {
 		if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) ) {
 			_deprecated_function( __METHOD__, '3.6.0', 'wpdb::prepare() or esc_sql()' );
 		}
 		return $data;
 	}
 	/**
-	 * Escapes content by reference for insertion into the database, for security
+	 * Escapes content by reference for insertion into the database, for security.
 	 *
 	 * @uses wpdb::_real_escape()
 	 *
 	 * @since 2.3.0
 	 *
-	 * @param string $string to escape
+	 * @param string $string String to escape.
 	 */
 	public function escape_by_ref( &$string ) {
 		if ( ! is_float( $string ) ) {
 			$string = $this->_real_escape( $string );
 		}
 	}
 	/**
-	 * Prepares a SQL query for safe execution. Uses sprintf()-like syntax.
+	 * Prepares a SQL query for safe execution.
 	 *
-	 * The following placeholders can be used in the query string:
+	 * Uses sprintf()-like syntax. The following placeholders can be used in the query string:
 	 *   %d (integer)
 	 *   %f (float)
 	 *   %s (string)
 	 *
-	 * All placeholders MUST be left unquoted in the query string. A corresponding argument MUST be passed for each placeholder.
+	 * All placeholders MUST be left unquoted in the query string. A corresponding argument
-	 *
+	 * MUST be passed for each placeholder.
-	 * For compatibility with old behavior, numbered or formatted string placeholders (eg, %1$s, %5s) will not have quotes
+	 *
-	 * added by this function, so should be passed with appropriate quotes around them for your usage.
+	 * Note: There is one exception to the above: for compatibility with old behavior,
-	 *
+	 * numbered or formatted string placeholders (eg, %1$s, %5s) will not have quotes
-	 * Literal percentage signs (%) in the query string must be written as %%. Percentage wildcards (for example,
+	 * added by this function, so should be passed with appropriate quotes around them.
-	 * to use in LIKE syntax) must be passed via a substitution argument containing the complete LIKE string, these
+	 *
-	 * cannot be inserted directly in the query string. Also see wpdb::esc_like().
+	 * Literal percentage signs (%) in the query string must be written as %%. Percentage wildcards
-	 *
+	 * (for example, to use in LIKE syntax) must be passed via a substitution argument containing
-	 * Arguments may be passed as individual arguments to the method, or as a single array containing all arguments. A combination
+	 * the complete LIKE string, these cannot be inserted directly in the query string.
-	 * of the two is not supported.
+	 * Also see wpdb::esc_like().
+	 *
+	 * Arguments may be passed as individual arguments to the method, or as a single array
+	 * containing all arguments. A combination of the two is not supported.
 	 *
 	 * Examples:
 	 *     $wpdb->prepare( "SELECT * FROM `table` WHERE `column` = %s AND `field` = %d OR `other_field` LIKE %s", array( 'foo', 1337, '%bar' ) );
 	 *     $wpdb->prepare( "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo' );
 	 *
-	 * @link https://secure.php.net/sprintf Description of syntax.
 	 * @since 2.3.0
-	 *
+	 * @since 5.3.0 Formalized the existing and already documented `...$args` parameter
-	 * @param string      $query    Query statement with sprintf()-like placeholders
+	 *              by updating the function signature. The second parameter was changed
-	 * @param array|mixed $args     The array of variables to substitute into the query's placeholders if being called with an array of arguments,
+	 *              from `$args` to `...$args`.
-	 *                              or the first variable to substitute into the query's placeholders if being called with individual arguments.
+	 *
-	 * @param mixed       $args,... further variables to substitute into the query's placeholders if being called wih individual arguments.
+	 * @link https://www.php.net/sprintf Description of syntax.
+	 *
+	 * @param string      $query   Query statement with sprintf()-like placeholders.
+	 * @param array|mixed $args    The array of variables to substitute into the query's placeholders
+	 *                             if being called with an array of arguments, or the first variable
+	 *                             to substitute into the query's placeholders if being called with
+	 *                             individual arguments.
+	 * @param mixed       ...$args Further variables to substitute into the query's placeholders
+	 *                             if being called with individual arguments.
 	 * @return string|void Sanitized query string, if there is a query to prepare.
 	 */
-	public function prepare( $query, $args ) {
+	public function prepare( $query, ...$args ) {
 		if ( is_null( $query ) ) {
 			return;
 		}
 		// This is not meant to be foolproof -- but it will catch obviously incorrect usage.
 		if ( strpos( $query, '%' ) === false ) {
 			wp_load_translations_early();
-			_doing_it_wrong( 'wpdb::prepare', sprintf( __( 'The query argument of %s must have a placeholder.' ), 'wpdb::prepare()' ), '3.9.0' );
+			_doing_it_wrong(
-		}
+				'wpdb::prepare',
+				sprintf(
-		$args = func_get_args();
+					/* translators: %s: wpdb::prepare() */
-		array_shift( $args );
+					__( 'The query argument of %s must have a placeholder.' ),
+					'wpdb::prepare()'
+				),
+				'3.9.0'
+			);
+		}
 		// If args were passed as an array (as in vsprintf), move them up.
 		$passed_as_array = false;
-		if ( is_array( $args[0] ) && count( $args ) == 1 ) {
+		if ( is_array( $args[0] ) && count( $args ) === 1 ) {
 			$passed_as_array = true;
 			$args            = $args[0];
 		}
 		foreach ( $args as $arg ) {
 			if ( ! is_scalar( $arg ) && ! is_null( $arg ) ) {
 				wp_load_translations_early();
-				_doing_it_wrong( 'wpdb::prepare', sprintf( __( 'Unsupported value type (%s).' ), gettype( $arg ) ), '4.8.2' );
+				_doing_it_wrong(
+					'wpdb::prepare',
+					sprintf(
+						/* translators: %s: Value type. */
+						__( 'Unsupported value type (%s).' ),
+						gettype( $arg )
+					),
+					'4.8.2'
+				);
 			}
 		}
 		/*
 		 * Specify the formatting allowed in a placeholder. The following are allowed:
 		 */
 		$query = str_replace( "'%s'", '%s', $query ); // Strip any existing single quotes.
 		$query = str_replace( '"%s"', '%s', $query ); // Strip any existing double quotes.
 		$query = preg_replace( '/(?<!%)%s/', "'%s'", $query ); // Quote the strings, avoiding escaped strings like %%s.
-		$query = preg_replace( "/(?<!%)(%($allowed_format)?f)/", '%\\2F', $query ); // Force floats to be locale unaware.
+		$query = preg_replace( "/(?<!%)(%($allowed_format)?f)/", '%\\2F', $query ); // Force floats to be locale-unaware.
 		$query = preg_replace( "/%(?:%|$|(?!($allowed_format)?[sdF]))/", '%%\\1', $query ); // Escape any unescaped percents.
 		// Count the number of valid placeholders in the query.
 		$placeholders = preg_match_all( "/(^|[^%]|(%%)+)%($allowed_format)?[sdF]/", $query, $matches );
 		if ( count( $args ) !== $placeholders ) {
 			if ( 1 === $placeholders && $passed_as_array ) {
 				// If the passed query only expected one argument, but the wrong number of arguments were sent as an array, bail.
 				wp_load_translations_early();
-				_doing_it_wrong( 'wpdb::prepare', __( 'The query only expected one placeholder, but an array of multiple placeholders was sent.' ), '4.9.0' );
+				_doing_it_wrong(
+					'wpdb::prepare',
+					__( 'The query only expected one placeholder, but an array of multiple placeholders was sent.' ),
+					'4.9.0'
+				);
 				return;
 			} else {
 				/*
 				 * If we don't have the right number of placeholders, but they were passed as individual arguments,
 				 * or we were expecting multiple arguments in an array, throw a warning.
 				 */
 				wp_load_translations_early();
 				_doing_it_wrong(
 					'wpdb::prepare',
-					/* translators: 1: number of placeholders, 2: number of arguments passed */
 					sprintf(
+						/* translators: 1: Number of placeholders, 2: Number of arguments passed. */
 						__( 'The query does not contain the correct number of placeholders (%1$d) for the number of arguments passed (%2$d).' ),
 						$placeholders,
 						count( $args )
 					),
 					'4.8.3'
 				);
 			}
 		}
 		array_walk( $args, array( $this, 'escape_by_ref' ) );
-		$query = @vsprintf( $query, $args );
+		$query = vsprintf( $query, $args );
 		return $this->add_placeholder_escape( $query );
 	}
 	/**
 	 * First half of escaping for LIKE special characters % and _ before preparing for MySQL.
 	 *
-	 * Use this only before wpdb::prepare() or esc_sql().  Reversing the order is very bad for security.
+	 * Use this only before wpdb::prepare() or esc_sql(). Reversing the order is very bad for security.
 	 *
 	 * Example Prepared Statement:
 	 *
 	 *     $wild = '%';
 	 *     $find = 'only 43% of planets';
 	 *
 	 *     $sql  = esc_sql( $wpdb->esc_like( $input ) );
 	 *
 	 * @since 4.0.0
 	 *
-	 * @param string $text The raw text to be escaped. The input typed by the user should have no
+	 * @param string $text The raw text to be escaped. The input typed by the user
-	 *                     extra or deleted slashes.
+	 *                     should have no extra or deleted slashes.
-	 * @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call $wpdb::prepare()
+	 * @return string Text in the form of a LIKE phrase. The output is not SQL safe.
-	 *                or real_escape next.
+	 *                Call wpdb::prepare() or wpdb::_real_escape() next.
 	 */
 	public function esc_like( $text ) {
 		return addcslashes( $text, '_%\\' );
 	}
 	/**
-	 * Print SQL/DB error.
+	 * Prints SQL/DB error.
 	 *
 	 * @since 0.71
-	 * @global array $EZSQL_ERROR Stores error information of query and error string
+	 *
-	 *
+	 * @global array $EZSQL_ERROR Stores error information of query and error string.
-	 * @param string $str The error to display
+	 *
-	 * @return false|void False if the showing of errors is disabled.
+	 * @param string $str The error to display.
+	 * @return void|false Void if the showing of errors is enabled, false if disabled.
 	 */
 	public function print_error( $str = '' ) {
 		global $EZSQL_ERROR;
 		if ( ! $str ) {
 			return false;
 		}
 		wp_load_translations_early();
-		if ( $caller = $this->get_caller() ) {
+		$caller = $this->get_caller();
-			/* translators: 1: Database error message, 2: SQL query, 3: Name of the calling function */
+		if ( $caller ) {
+			/* translators: 1: Database error message, 2: SQL query, 3: Name of the calling function. */
 			$error_str = sprintf( __( 'WordPress database error %1$s for query %2$s made by %3$s' ), $str, $this->last_query, $caller );
 		} else {
-			/* translators: 1: Database error message, 2: SQL query */
+			/* translators: 1: Database error message, 2: SQL query. */
 			$error_str = sprintf( __( 'WordPress database error %1$s for query %2$s' ), $str, $this->last_query );
 		}
 		error_log( $error_str );
 		// Are we showing errors?
 		if ( ! $this->show_errors ) {
 			return false;
 		}
-		// If there is an error then take note of it
+		// If there is an error then take note of it.
 		if ( is_multisite() ) {
 			$msg = sprintf(
 				"%s [%s]\n%s\n",
 				__( 'WordPress database error:' ),
 				$str,
 	/**
 	 * Enables showing of database errors.
 	 *
 	 * This function should be used only to enable showing of errors.
-	 * wpdb::hide_errors() should be used instead for hiding of errors. However,
+	 * wpdb::hide_errors() should be used instead for hiding errors.
-	 * this function can be used to enable and disable showing of database
-	 * errors.
 	 *
 	 * @since 0.71
+	 *
 	 * @see wpdb::hide_errors()
 	 *
-	 * @param bool $show Whether to show or hide errors
+	 * @param bool $show Optional. Whether to show errors. Default true.
-	 * @return bool Old value for showing errors.
+	 * @return bool Whether showing of errors was previously active.
 	 */
 	public function show_errors( $show = true ) {
 		$errors            = $this->show_errors;
 		$this->show_errors = $show;
 		return $errors;
 	 * Disables showing of database errors.
 	 *
 	 * By default database errors are not shown.
 	 *
 	 * @since 0.71
+	 *
 	 * @see wpdb::show_errors()
 	 *
-	 * @return bool Whether showing of errors was active
+	 * @return bool Whether showing of errors was previously active.
 	 */
 	public function hide_errors() {
 		$show              = $this->show_errors;
 		$this->show_errors = false;
 		return $show;
 	}
 	/**
-	 * Whether to suppress database errors.
+	 * Enables or disables suppressing of database errors.
 	 *
-	 * By default database errors are suppressed, with a simple
+	 * By default database errors are suppressed.
-	 * call to this function they can be enabled.
 	 *
 	 * @since 2.5.0
+	 *
 	 * @see wpdb::hide_errors()
-	 * @param bool $suppress Optional. New value. Defaults to true.
+	 *
-	 * @return bool Old value
+	 * @param bool $suppress Optional. Whether to suppress errors. Default true.
+	 * @return bool Whether suppressing of errors was previously active.
 	 */
 	public function suppress_errors( $suppress = true ) {
 		$errors                = $this->suppress_errors;
 		$this->suppress_errors = (bool) $suppress;
 		return $errors;
 	}
 	/**
-	 * Kill cached query results.
+	 * Kills cached query results.
 	 *
 	 * @since 0.71
 	 */
 	public function flush() {
 		$this->last_result   = array();
 		$this->col_info      = null;
 		$this->last_query    = null;
-		$this->rows_affected = $this->num_rows = 0;
+		$this->rows_affected = 0;
+		$this->num_rows      = 0;
 		$this->last_error    = '';
 		if ( $this->use_mysqli && $this->result instanceof mysqli_result ) {
 			mysqli_free_result( $this->result );
 			$this->result = null;
-			// Sanity check before using the handle
+			// Sanity check before using the handle.
 			if ( empty( $this->dbh ) || ! ( $this->dbh instanceof mysqli ) ) {
 				return;
 			}
-			// Clear out any results from a multi-query
+			// Clear out any results from a multi-query.
 			while ( mysqli_more_results( $this->dbh ) ) {
 				mysqli_next_result( $this->dbh );
 			}
 		} elseif ( is_resource( $this->result ) ) {
 			mysql_free_result( $this->result );
 		}
 	}
 	/**
-	 * Connect to and select database.
+	 * Connects to and selects database.
 	 *
-	 * If $allow_bail is false, the lack of database connection will need
+	 * If $allow_bail is false, the lack of database connection will need to be handled manually.
-	 * to be handled manually.
 	 *
 	 * @since 3.0.0
 	 * @since 3.9.0 $allow_bail parameter added.
 	 *
 	 * @param bool $allow_bail Optional. Allows the function to bail. Default true.
 			$host    = $this->dbhost;
 			$port    = null;
 			$socket  = null;
 			$is_ipv6 = false;
-			if ( $host_data = $this->parse_db_host( $this->dbhost ) ) {
+			$host_data = $this->parse_db_host( $this->dbhost );
+			if ( $host_data ) {
 				list( $host, $port, $socket, $is_ipv6 ) = $host_data;
 			}
 			/*
-			 * If using the `mysqlnd` library, the IPv6 address needs to be
+			 * If using the `mysqlnd` library, the IPv6 address needs to be enclosed
-			 * enclosed in square brackets, whereas it doesn't while using the
+			 * in square brackets, whereas it doesn't while using the `libmysqlclient` library.
-			 * `libmysqlclient` library.
 			 * @see https://bugs.php.net/bug.php?id=67563
 			 */
 			if ( $is_ipv6 && extension_loaded( 'mysqlnd' ) ) {
 				$host = "[$host]";
 			}
 			if ( WP_DEBUG ) {
 				mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
 			} else {
+				// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
 				@mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
 			}
 			if ( $this->dbh->connect_errno ) {
 				$this->dbh = null;
 				/*
 				 * It's possible ext/mysqli is misconfigured. Fall back to ext/mysql if:
-				  *  - We haven't previously connected, and
+				 *  - We haven't previously connected, and
-				  *  - WP_USE_EXT_MYSQL isn't set to false, and
+				 *  - WP_USE_EXT_MYSQL isn't set to false, and
-				  *  - ext/mysql is loaded.
+				 *  - ext/mysql is loaded.
-				  */
+				 */
 				$attempt_fallback = true;
 				if ( $this->has_connected ) {
 					$attempt_fallback = false;
 				} elseif ( defined( 'WP_USE_EXT_MYSQL' ) && ! WP_USE_EXT_MYSQL ) {
 			}
 		} else {
 			if ( WP_DEBUG ) {
 				$this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
 			} else {
+				// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
 				$this->dbh = @mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
 			}
 		}
 		if ( ! $this->dbh && $allow_bail ) {
 			wp_load_translations_early();
 			// Load custom DB error template, if present.
 			if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
-				require_once( WP_CONTENT_DIR . '/db-error.php' );
+				require_once WP_CONTENT_DIR . '/db-error.php';
 				die();
 			}
 			$message = '<h1>' . __( 'Error establishing a database connection' ) . "</h1>\n";
 			$message .= '<p>' . sprintf(
-				/* translators: 1: wp-config.php, 2: database host */
+				/* translators: 1: wp-config.php, 2: Database host. */
 				__( 'This either means that the username and password information in your %1$s file is incorrect or we can&#8217;t contact the database server at %2$s. This could mean your host&#8217;s database server is down.' ),
 				'<code>wp-config.php</code>',
 				'<code>' . htmlspecialchars( $this->dbhost, ENT_QUOTES ) . '</code>'
 			) . "</p>\n";
 			$message .= "<ul>\n";
 			$message .= '<li>' . __( 'Are you sure you have the correct username and password?' ) . "</li>\n";
-			$message .= '<li>' . __( 'Are you sure that you have typed the correct hostname?' ) . "</li>\n";
+			$message .= '<li>' . __( 'Are you sure you have typed the correct hostname?' ) . "</li>\n";
-			$message .= '<li>' . __( 'Are you sure that the database server is running?' ) . "</li>\n";
+			$message .= '<li>' . __( 'Are you sure the database server is running?' ) . "</li>\n";
 			$message .= "</ul>\n";
 			$message .= '<p>' . sprintf(
-				/* translators: %s: support forums URL */
+				/* translators: %s: Support forums URL. */
 				__( 'If you&#8217;re unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href="%s">WordPress Support Forums</a>.' ),
 				__( 'https://wordpress.org/support/forums/' )
 			) . "</p>\n";
 			$this->bail( $message, 'db_connect_fail' );
 		return false;
 	}
 	/**
-	 * Parse the DB_HOST setting to interpret it for mysqli_real_connect.
+	 * Parses the DB_HOST setting to interpret it for mysqli_real_connect().
 	 *
-	 * mysqli_real_connect doesn't support the host param including a port or
+	 * mysqli_real_connect() doesn't support the host param including a port or socket
-	 * socket like mysql_connect does. This duplicates how mysql_connect detects
+	 * like mysql_connect() does. This duplicates how mysql_connect() detects a port
-	 * a port and/or socket file.
+	 * and/or socket file.
 	 *
 	 * @since 4.9.0
 	 *
 	 * @param string $host The DB_HOST setting to parse.
-	 * @return array|bool Array containing the host, the port, the socket and whether
+	 * @return array|false Array containing the host, the port, the socket and
-	 *                    it is an IPv6 address, in that order. If $host couldn't be parsed,
+	 *                     whether it is an IPv6 address, in that order.
-	 *                    returns false.
+	 *                     False if $host couldn't be parsed.
 	 */
 	public function parse_db_host( $host ) {
 		$port    = null;
 		$socket  = null;
 		$is_ipv6 = false;
 		// First peel off the socket parameter from the right, if it exists.
 		$socket_pos = strpos( $host, ':/' );
-		if ( $socket_pos !== false ) {
+		if ( false !== $socket_pos ) {
 			$socket = substr( $host, $socket_pos + 1 );
 			$host   = substr( $host, 0, $socket_pos );
 		}
 		// We need to check for an IPv6 address first.
 	}
 	/**
 	 * Checks that the connection to the database is still up. If not, try to reconnect.
 	 *
-	 * If this function is unable to reconnect, it will forcibly die, or if after the
+	 * If this function is unable to reconnect, it will forcibly die, or if called
-	 * the {@see 'template_redirect'} hook has been fired, return false instead.
+	 * after the {@see 'template_redirect'} hook has been fired, return false instead.
 	 *
-	 * If $allow_bail is false, the lack of database connection will need
+	 * If $allow_bail is false, the lack of database connection will need to be handled manually.
-	 * to be handled manually.
 	 *
 	 * @since 3.9.0
 	 *
 	 * @param bool $allow_bail Optional. Allows the function to bail. Default true.
 	 * @return bool|void True if the connection is up.
 			}
 		}
 		$error_reporting = false;
-		// Disable warnings, as we don't want to see a multitude of "unable to connect" messages
+		// Disable warnings, as we don't want to see a multitude of "unable to connect" messages.
 		if ( WP_DEBUG ) {
 			$error_reporting = error_reporting();
 			error_reporting( $error_reporting & ~E_WARNING );
 		}
 		for ( $tries = 1; $tries <= $this->reconnect_retries; $tries++ ) {
-			// On the last try, re-enable warnings. We want to see a single instance of the
+			// On the last try, re-enable warnings. We want to see a single instance
-			// "unable to connect" message on the bail() screen, if it appears.
+			// of the "unable to connect" message on the bail() screen, if it appears.
 			if ( $this->reconnect_retries === $tries && WP_DEBUG ) {
 				error_reporting( $error_reporting );
 			}
 			if ( $this->db_connect( false ) ) {
 		wp_load_translations_early();
 		$message = '<h1>' . __( 'Error reconnecting to the database' ) . "</h1>\n";
 		$message .= '<p>' . sprintf(
-			/* translators: %s: database host */
+			/* translators: %s: Database host. */
 			__( 'This means that we lost contact with the database server at %s. This could mean your host&#8217;s database server is down.' ),
 			'<code>' . htmlspecialchars( $this->dbhost, ENT_QUOTES ) . '</code>'
 		) . "</p>\n";
 		$message .= "<ul>\n";
-		$message .= '<li>' . __( 'Are you sure that the database server is running?' ) . "</li>\n";
+		$message .= '<li>' . __( 'Are you sure the database server is running?' ) . "</li>\n";
-		$message .= '<li>' . __( 'Are you sure that the database server is not under particularly heavy load?' ) . "</li>\n";
+		$message .= '<li>' . __( 'Are you sure the database server is not under particularly heavy load?' ) . "</li>\n";
 		$message .= "</ul>\n";
 		$message .= '<p>' . sprintf(
-			/* translators: %s: support forums URL */
+			/* translators: %s: Support forums URL. */
 			__( 'If you&#8217;re unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href="%s">WordPress Support Forums</a>.' ),
 			__( 'https://wordpress.org/support/forums/' )
 		) . "</p>\n";
 		// We weren't able to reconnect, so we better bail.
 		$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();
 	}
 	/**
-	 * Perform a MySQL database query, using current database connection.
+	 * Performs a MySQL database query, using current database connection.
 	 *
-	 * More information can be found on the codex page.
+	 * More information can be found on the Codex page.
 	 *
 	 * @since 0.71
 	 *
-	 * @param string $query Database query
+	 * @link https://codex.wordpress.org/Function_Reference/wpdb_Class
+	 *
+	 * @param string $query Database query.
 	 * @return int|bool Boolean true for CREATE, ALTER, TRUNCATE and DROP queries. Number of rows
 	 *                  affected/selected for all other queries. Boolean false on error.
 	 */
 	public function query( $query ) {
 		if ( ! $this->ready ) {
 		 */
 		$query = apply_filters( 'query', $query );
 		$this->flush();
-		// Log how the function was called
+		// Log how the function was called.
 		$this->func_call = "\$db->query(\"$query\")";
 		// If we're writing to the database, make sure the query will write safely.
 		if ( $this->check_current_query && ! $this->check_ascii( $query ) ) {
 			$stripped_query = $this->strip_invalid_text_from_query( $query );
 					$mysql_errno = 2006;
 				}
 			}
 		}
-		if ( empty( $this->dbh ) || 2006 == $mysql_errno ) {
+		if ( empty( $this->dbh ) || 2006 === $mysql_errno ) {
 			if ( $this->check_connection() ) {
 				$this->_do_query( $query );
 			} else {
 				$this->insert_id = 0;
 				return false;
 			if ( $this->use_mysqli ) {
 				$this->rows_affected = mysqli_affected_rows( $this->dbh );
 			} else {
 				$this->rows_affected = mysql_affected_rows( $this->dbh );
 			}
-			// Take note of the insert_id
+			// Take note of the insert_id.
 			if ( preg_match( '/^\s*(insert|replace)\s/i', $query ) ) {
 				if ( $this->use_mysqli ) {
 					$this->insert_id = mysqli_insert_id( $this->dbh );
 				} else {
 					$this->insert_id = mysql_insert_id( $this->dbh );
 				}
 			}
-			// Return number of rows affected
+			// Return number of rows affected.
 			$return_val = $this->rows_affected;
 		} else {
 			$num_rows = 0;
 			if ( $this->use_mysqli && $this->result instanceof mysqli_result ) {
 				while ( $row = mysqli_fetch_object( $this->result ) ) {
 					$this->last_result[ $num_rows ] = $row;
 					$num_rows++;
 				}
 			}
-			// Log number of rows the query returned
+			// Log and return the number of rows selected.
-			// and return number of rows selected
 			$this->num_rows = $num_rows;
 			$return_val     = $num_rows;
 		}
 		return $return_val;
 			$this->result = mysql_query( $query, $this->dbh );
 		}
 		$this->num_queries++;
 		if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) {
-			$this->queries[] = array(
+			$this->log_query(
 				$query,
 				$this->timer_stop(),
 				$this->get_caller(),
 				$this->time_start,
+				array()
 			);
 		}
+	}
+	/**
+	 * Logs query data.
+	 *
+	 * @since 5.3.0
+	 *
+	 * @param string $query           The query's SQL.
+	 * @param float  $query_time      Total time spent on the query, in seconds.
+	 * @param string $query_callstack Comma-separated list of the calling functions.
+	 * @param float  $query_start     Unix timestamp of the time at the start of the query.
+	 * @param array  $query_data      Custom query data.
+	 */
+	public function log_query( $query, $query_time, $query_callstack, $query_start, $query_data ) {
+		/**
+		 * Filters the custom query data being logged.
+		 *
+		 * Caution should be used when modifying any of this data, it is recommended that any additional
+		 * information you need to store about a query be added as a new associative entry to the fourth
+		 * element $query_data.
+		 *
+		 * @since 5.3.0
+		 *
+		 * @param array  $query_data      Custom query data.
+		 * @param string $query           The query's SQL.
+		 * @param float  $query_time      Total time spent on the query, in seconds.
+		 * @param string $query_callstack Comma-separated list of the calling functions.
+		 * @param float  $query_start     Unix timestamp of the time at the start of the query.
+		 */
+		$query_data = apply_filters( 'log_query_custom_data', $query_data, $query, $query_time, $query_callstack, $query_start );
+		$this->queries[] = array(
+			$query,
+			$query_time,
+			$query_callstack,
+			$query_start,
+			$query_data,
+		);
 	}
 	/**
 	 * Generates and returns a placeholder escape string for use in queries returned by ::prepare().
 	 *
 		/*
 		 * Add the filter to remove the placeholder escaper. Uses priority 0, so that anything
 		 * else attached to this filter will receive the query with the placeholder string removed.
 		 */
-		if ( ! has_filter( 'query', array( $this, 'remove_placeholder_escape' ) ) ) {
+		if ( false === has_filter( 'query', array( $this, 'remove_placeholder_escape' ) ) ) {
 			add_filter( 'query', array( $this, 'remove_placeholder_escape' ), 0 );
 		}
 		return $placeholder;
 	}
 	public function remove_placeholder_escape( $query ) {
 		return str_replace( $this->placeholder_escape(), '%', $query );
 	}
 	/**
-	 * Insert a row into a table.
+	 * Inserts a row into the table.
 	 *
+	 * Examples:
 	 *     wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
 	 *     wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
 	 *
 	 * @since 2.5.0
+	 *
 	 * @see wpdb::prepare()
 	 * @see wpdb::$field_types
 	 * @see wp_set_wpdb_vars()
 	 *
-	 * @param string       $table  Table name
+	 * @param string       $table  Table name.
 	 * @param array        $data   Data to insert (in column => value pairs).
 	 *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
-	 *                             Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
+	 *                             Sending a null value will cause the column to be set to NULL - the corresponding
+	 *                             format is ignored in this case.
 	 * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
 	 *                             If string, that format will be used for all of the values in $data.
 	 *                             A format is one of '%d', '%f', '%s' (integer, float, string).
-	 *                             If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+	 *                             If omitted, all values in $data will be treated as strings unless otherwise
+	 *                             specified in wpdb::$field_types.
 	 * @return int|false The number of rows inserted, or false on error.
 	 */
 	public function insert( $table, $data, $format = null ) {
 		return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' );
 	}
 	/**
-	 * Replace a row into a table.
+	 * Replaces a row in the table.
 	 *
+	 * Examples:
 	 *     wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
 	 *     wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
 	 *
 	 * @since 3.0.0
+	 *
 	 * @see wpdb::prepare()
 	 * @see wpdb::$field_types
 	 * @see wp_set_wpdb_vars()
 	 *
-	 * @param string       $table  Table name
+	 * @param string       $table  Table name.
 	 * @param array        $data   Data to insert (in column => value pairs).
 	 *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
-	 *                             Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
+	 *                             Sending a null value will cause the column to be set to NULL - the corresponding
+	 *                             format is ignored in this case.
 	 * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
 	 *                             If string, that format will be used for all of the values in $data.
 	 *                             A format is one of '%d', '%f', '%s' (integer, float, string).
-	 *                             If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+	 *                             If omitted, all values in $data will be treated as strings unless otherwise
+	 *                             specified in wpdb::$field_types.
 	 * @return int|false The number of rows affected, or false on error.
 	 */
 	public function replace( $table, $data, $format = null ) {
 		return $this->_insert_replace_helper( $table, $data, $format, 'REPLACE' );
 	}
 	 * Helper function for insert and replace.
 	 *
 	 * Runs an insert or replace query based on $type argument.
 	 *
 	 * @since 3.0.0
+	 *
 	 * @see wpdb::prepare()
 	 * @see wpdb::$field_types
 	 * @see wp_set_wpdb_vars()
 	 *
-	 * @param string       $table  Table name
+	 * @param string       $table  Table name.
 	 * @param array        $data   Data to insert (in column => value pairs).
 	 *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
-	 *                             Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
+	 *                             Sending a null value will cause the column to be set to NULL - the corresponding
+	 *                             format is ignored in this case.
 	 * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
 	 *                             If string, that format will be used for all of the values in $data.
 	 *                             A format is one of '%d', '%f', '%s' (integer, float, string).
-	 *                             If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+	 *                             If omitted, all values in $data will be treated as strings unless otherwise
-	 * @param string $type         Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT.
+	 *                             specified in wpdb::$field_types.
+	 * @param string       $type   Optional. Type of operation. Possible values include 'INSERT' or 'REPLACE'.
+	 *                             Default 'INSERT'.
 	 * @return int|false The number of rows affected, or false on error.
 	 */
 	function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {
 		$this->insert_id = 0;
-		if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ) ) ) {
+		if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ), true ) ) {
 			return false;
 		}
 		$data = $this->process_fields( $table, $data, $format );
 		if ( false === $data ) {
 			return false;
 		}
-		$formats = $values = array();
+		$formats = array();
+		$values  = array();
 		foreach ( $data as $value ) {
 			if ( is_null( $value['value'] ) ) {
 				$formats[] = 'NULL';
 				continue;
 			}
 		$this->check_current_query = false;
 		return $this->query( $this->prepare( $sql, $values ) );
 	}
 	/**
-	 * Update a row in the table
+	 * Updates a row in the table.
 	 *
+	 * Examples:
 	 *     wpdb::update( 'table', array( 'column' => 'foo', 'field' => 'bar' ), array( 'ID' => 1 ) )
 	 *     wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) )
 	 *
 	 * @since 2.5.0
+	 *
 	 * @see wpdb::prepare()
 	 * @see wpdb::$field_types
 	 * @see wp_set_wpdb_vars()
 	 *
-	 * @param string       $table        Table name
+	 * @param string       $table        Table name.
 	 * @param array        $data         Data to update (in column => value pairs).
 	 *                                   Both $data columns and $data values should be "raw" (neither should be SQL escaped).
 	 *                                   Sending a null value will cause the column to be set to NULL - the corresponding
 	 *                                   format is ignored in this case.
 	 * @param array        $where        A named array of WHERE clauses (in column => value pairs).
 	 *                                   Multiple clauses will be joined with ANDs.
 	 *                                   Both $where columns and $where values should be "raw".
-	 *                                   Sending a null value will create an IS NULL comparison - the corresponding format will be ignored in this case.
+	 *                                   Sending a null value will create an IS NULL comparison - the corresponding
+	 *                                   format will be ignored in this case.
 	 * @param array|string $format       Optional. An array of formats to be mapped to each of the values in $data.
 	 *                                   If string, that format will be used for all of the values in $data.
 	 *                                   A format is one of '%d', '%f', '%s' (integer, float, string).
-	 *                                   If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+	 *                                   If omitted, all values in $data will be treated as strings unless otherwise
+	 *                                   specified in wpdb::$field_types.
 	 * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where.
 	 *                                   If string, that format will be used for all of the items in $where.
 	 *                                   A format is one of '%d', '%f', '%s' (integer, float, string).
 	 *                                   If omitted, all values in $where will be treated as strings.
 	 * @return int|false The number of rows updated, or false on error.
 		$where = $this->process_fields( $table, $where, $where_format );
 		if ( false === $where ) {
 			return false;
 		}
-		$fields = $conditions = $values = array();
+		$fields     = array();
+		$conditions = array();
+		$values     = array();
 		foreach ( $data as $field => $value ) {
 			if ( is_null( $value['value'] ) ) {
 				$fields[] = "`$field` = NULL";
 				continue;
 			}
 		$this->check_current_query = false;
 		return $this->query( $this->prepare( $sql, $values ) );
 	}
 	/**
-	 * Delete a row in the table
+	 * Deletes a row in the table.
 	 *
+	 * Examples:
 	 *     wpdb::delete( 'table', array( 'ID' => 1 ) )
 	 *     wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) )
 	 *
 	 * @since 3.4.0
+	 *
 	 * @see wpdb::prepare()
 	 * @see wpdb::$field_types
 	 * @see wp_set_wpdb_vars()
 	 *
-	 * @param string       $table        Table name
+	 * @param string       $table        Table name.
 	 * @param array        $where        A named array of WHERE clauses (in column => value pairs).
 	 *                                   Multiple clauses will be joined with ANDs.
 	 *                                   Both $where columns and $where values should be "raw".
-	 *                                   Sending a null value will create an IS NULL comparison - the corresponding format will be ignored in this case.
+	 *                                   Sending a null value will create an IS NULL comparison - the corresponding
+	 *                                   format will be ignored in this case.
 	 * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where.
 	 *                                   If string, that format will be used for all of the items in $where.
 	 *                                   A format is one of '%d', '%f', '%s' (integer, float, string).
-	 *                                   If omitted, all values in $where will be treated as strings unless otherwise specified in wpdb::$field_types.
+	 *                                   If omitted, all values in $data will be treated as strings unless otherwise
+	 *                                   specified in wpdb::$field_types.
 	 * @return int|false The number of rows updated, or false on error.
 	 */
 	public function delete( $table, $where, $where_format = null ) {
 		if ( ! is_array( $where ) ) {
 			return false;
 		$where = $this->process_fields( $table, $where, $where_format );
 		if ( false === $where ) {
 			return false;
 		}
-		$conditions = $values = array();
+		$conditions = array();
+		$values     = array();
 		foreach ( $where as $field => $value ) {
 			if ( is_null( $value['value'] ) ) {
 				$conditions[] = "`$field` IS NULL";
 				continue;
 			}
 	}
 	/**
 	 * Processes arrays of field/value pairs and field formats.
 	 *
-	 * This is a helper method for wpdb's CRUD methods, which take field/value
+	 * This is a helper method for wpdb's CRUD methods, which take field/value pairs
-	 * pairs for inserts, updates, and where clauses. This method first pairs
+	 * for inserts, updates, and where clauses. This method first pairs each value
-	 * each value with a format. Then it determines the charset of that field,
+	 * with a format. Then it determines the charset of that field, using that
-	 * using that to determine if any invalid text would be stripped. If text is
+	 * to determine if any invalid text would be stripped. If text is stripped,
-	 * stripped, then field processing is rejected and the query fails.
+	 * then field processing is rejected and the query fails.
 	 *
 	 * @since 4.2.0
 	 *
 	 * @param string $table  Table name.
 	 * @param array  $data   Field/value pair.
 	 * @param mixed  $format Format for each field.
-	 * @return array|false Returns an array of fields that contain paired values
+	 * @return array|false An array of fields that contain paired value and formats.
-	 *                    and formats. Returns false for invalid values.
+	 *                     False for invalid values.
 	 */
 	protected function process_fields( $table, $data, $format ) {
 		$data = $this->process_field_formats( $data, $format );
 		if ( false === $data ) {
 			return false;
 	 * @param mixed $format Formats to be mapped to the values in $data.
 	 * @return array Array, keyed by field names with values being an array
 	 *               of 'value' and 'format' keys.
 	 */
 	protected function process_field_formats( $data, $format ) {
-		$formats = $original_formats = (array) $format;
+		$formats          = (array) $format;
+		$original_formats = $formats;
 		foreach ( $data as $field => $value ) {
 			$value = array(
 				'value'  => $value,
 				'format' => '%s',
 		return $data;
 	}
 	/**
-	 * Adds field charsets to field/value/format arrays generated by
+	 * Adds field charsets to field/value/format arrays generated by wpdb::process_field_formats().
-	 * the wpdb::process_field_formats() method.
 	 *
 	 * @since 4.2.0
 	 *
 	 * @param array  $data  As it comes from the wpdb::process_field_formats() method.
 	 * @param string $table Table name.
 	 * @return array|false The same array as $data with additional 'charset' keys.
+	 *                     False on failure.
 	 */
 	protected function process_field_charsets( $data, $table ) {
 		foreach ( $data as $field => $value ) {
 			if ( '%d' === $value['format'] || '%f' === $value['format'] ) {
 				/*
 		return $data;
 	}
 	/**
-	 * For string fields, record the maximum string length that field can safely save.
+	 * For string fields, records the maximum string length that field can safely save.
 	 *
 	 * @since 4.2.1
 	 *
 	 * @param array  $data  As it comes from the wpdb::process_field_charsets() method.
 	 * @param string $table Table name.
 		return $data;
 	}
 	/**
-	 * Retrieve one variable from the database.
+	 * Retrieves one variable from the database.
 	 *
 	 * Executes a SQL query and returns the value from the SQL result.
-	 * If the SQL result contains more than one column and/or more than one row, this function returns the value in the column and row specified.
+	 * If the SQL result contains more than one column and/or more than one row,
-	 * If $query is null, this function returns the value in the specified column and row from the previous SQL result.
+	 * the value in the column and row specified is returned. If $query is null,
+	 * the value in the specified column and row from the previous SQL result is returned.
 	 *
 	 * @since 0.71
 	 *
 	 * @param string|null $query Optional. SQL query. Defaults to null, use the result from the previous query.
 	 * @param int         $x     Optional. Column of value to return. Indexed from 0.
 	 * @param int         $y     Optional. Row of value to return. Indexed from 0.
-	 * @return string|null Database query result (as string), or null on failure
+	 * @return string|null Database query result (as string), or null on failure.
 	 */
 	public function get_var( $query = null, $x = 0, $y = 0 ) {
 		$this->func_call = "\$db->get_var(\"$query\", $x, $y)";
 		if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
 		if ( $query ) {
 			$this->query( $query );
 		}
-		// Extract var out of cached results based x,y vals
+		// Extract var out of cached results based on x,y vals.
 		if ( ! empty( $this->last_result[ $y ] ) ) {
 			$values = array_values( get_object_vars( $this->last_result[ $y ] ) );
 		}
-		// If there is a value return it else return null
+		// If there is a value return it, else return null.
-		return ( isset( $values[ $x ] ) && $values[ $x ] !== '' ) ? $values[ $x ] : null;
+		return ( isset( $values[ $x ] ) && '' !== $values[ $x ] ) ? $values[ $x ] : null;
 	}
 	/**
-	 * Retrieve one row from the database.
+	 * Retrieves one row from the database.
 	 *
 	 * Executes a SQL query and returns the row from the SQL result.
 	 *
 	 * @since 0.71
 	 *
 	 * @param string|null $query  SQL query.
-	 * @param string      $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+	 * @param string      $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
-	 *                            an stdClass object, an associative array, or a numeric array, respectively. Default OBJECT.
+	 *                            correspond to an stdClass object, an associative array, or a numeric array,
+	 *                            respectively. Default OBJECT.
 	 * @param int         $y      Optional. Row to return. Indexed from 0.
-	 * @return array|object|null|void Database query result in format specified by $output or null on failure
+	 * @return array|object|null|void Database query result in format specified by $output or null on failure.
 	 */
 	public function get_row( $query = null, $output = OBJECT, $y = 0 ) {
 		$this->func_call = "\$db->get_row(\"$query\",$output,$y)";
 		if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
 		if ( ! isset( $this->last_result[ $y ] ) ) {
 			return null;
 		}
-		if ( $output == OBJECT ) {
+		if ( OBJECT === $output ) {
 			return $this->last_result[ $y ] ? $this->last_result[ $y ] : null;
-		} elseif ( $output == ARRAY_A ) {
+		} elseif ( ARRAY_A === $output ) {
 			return $this->last_result[ $y ] ? get_object_vars( $this->last_result[ $y ] ) : null;
-		} elseif ( $output == ARRAY_N ) {
+		} elseif ( ARRAY_N === $output ) {
 			return $this->last_result[ $y ] ? array_values( get_object_vars( $this->last_result[ $y ] ) ) : null;
-		} elseif ( strtoupper( $output ) === OBJECT ) {
+		} elseif ( OBJECT === strtoupper( $output ) ) {
-			// Back compat for OBJECT being previously case insensitive.
+			// Back compat for OBJECT being previously case-insensitive.
 			return $this->last_result[ $y ] ? $this->last_result[ $y ] : null;
 		} else {
 			$this->print_error( ' $db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N' );
 		}
 	}
 	/**
-	 * Retrieve one column from the database.
+	 * Retrieves one column from the database.
 	 *
 	 * Executes a SQL query and returns the column from the SQL result.
-	 * If the SQL result contains more than one column, this function returns the column specified.
+	 * If the SQL result contains more than one column, the column specified is returned.
-	 * If $query is null, this function returns the specified column from the previous SQL result.
+	 * If $query is null, the specified column from the previous SQL result is returned.
 	 *
 	 * @since 0.71
 	 *
 	 * @param string|null $query Optional. SQL query. Defaults to previous query.
 	 * @param int         $x     Optional. Column to return. Indexed from 0.
 		if ( $query ) {
 			$this->query( $query );
 		}
 		$new_array = array();
-		// Extract the column values
+		// Extract the column values.
 		if ( $this->last_result ) {
 			for ( $i = 0, $j = count( $this->last_result ); $i < $j; $i++ ) {
 				$new_array[ $i ] = $this->get_var( null, $x, $i );
 			}
 		}
 		return $new_array;
 	}
 	/**
-	 * Retrieve an entire SQL result set from the database (i.e., many rows)
+	 * Retrieves an entire SQL result set from the database (i.e., many rows).
 	 *
 	 * Executes a SQL query and returns the entire SQL result.
 	 *
 	 * @since 0.71
 	 *
 	 * @param string $query  SQL query.
 	 * @param string $output Optional. Any of ARRAY_A | ARRAY_N | OBJECT | OBJECT_K constants.
-	 *                       With one of the first three, return an array of rows indexed from 0 by SQL result row number.
+	 *                       With one of the first three, return an array of rows indexed
-	 *                       Each row is an associative array (column => value, ...), a numerically indexed array (0 => value, ...), or an object. ( ->column = value ), respectively.
+	 *                       from 0 by SQL result row number. Each row is an associative array
-	 *                       With OBJECT_K, return an associative array of row objects keyed by the value of each row's first column's value.
+	 *                       (column => value, ...), a numerically indexed array (0 => value, ...),
-	 *                       Duplicate keys are discarded.
+	 *                       or an object ( ->column = value ), respectively. With OBJECT_K,
-	 * @return array|object|null Database query results
+	 *                       return an associative array of row objects keyed by the value
+	 *                       of each row's first column's value. Duplicate keys are discarded.
+	 * @return array|object|null Database query results.
 	 */
 	public function get_results( $query = null, $output = OBJECT ) {
 		$this->func_call = "\$db->get_results(\"$query\", $output)";
 		if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
 		} else {
 			return null;
 		}
 		$new_array = array();
-		if ( $output == OBJECT ) {
+		if ( OBJECT === $output ) {
-			// Return an integer-keyed array of row objects
+			// Return an integer-keyed array of row objects.
 			return $this->last_result;
-		} elseif ( $output == OBJECT_K ) {
+		} elseif ( OBJECT_K === $output ) {
-			// Return an array of row objects with keys from column 1
+			// Return an array of row objects with keys from column 1.
-			// (Duplicates are discarded)
+			// (Duplicates are discarded.)
 			if ( $this->last_result ) {
 				foreach ( $this->last_result as $row ) {
 					$var_by_ref = get_object_vars( $row );
 					$key        = array_shift( $var_by_ref );
 					if ( ! isset( $new_array[ $key ] ) ) {
 						$new_array[ $key ] = $row;
 					}
 				}
 			}
 			return $new_array;
-		} elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
+		} elseif ( ARRAY_A === $output || ARRAY_N === $output ) {
 			// Return an integer-keyed array of...
 			if ( $this->last_result ) {
 				foreach ( (array) $this->last_result as $row ) {
-					if ( $output == ARRAY_N ) {
+					if ( ARRAY_N === $output ) {
-						// ...integer-keyed row arrays
+						// ...integer-keyed row arrays.
 						$new_array[] = array_values( get_object_vars( $row ) );
 					} else {
-						// ...column name-keyed row arrays
+						// ...column name-keyed row arrays.
 						$new_array[] = get_object_vars( $row );
 					}
 				}
 			}
 			return $new_array;
 		} elseif ( strtoupper( $output ) === OBJECT ) {
-			// Back compat for OBJECT being previously case insensitive.
+			// Back compat for OBJECT being previously case-insensitive.
 			return $this->last_result;
 		}
 		return null;
 	}
 		 * Passing a non-null value to the filter will effectively short-circuit
 		 * checking the DB for the charset, returning that value instead.
 		 *
 		 * @since 4.2.0
 		 *
-		 * @param string $charset The character set to use. Default null.
+		 * @param string|null $charset The character set to use. Default null.
-		 * @param string $table   The name of the table being checked.
+		 * @param string      $table   The name of the table being checked.
 		 */
 		$charset = apply_filters( 'pre_get_table_charset', null, $table );
 		if ( null !== $charset ) {
 			return $charset;
 		}
 		if ( isset( $this->table_charset[ $tablekey ] ) ) {
 			return $this->table_charset[ $tablekey ];
 		}
-		$charsets = $columns = array();
+		$charsets = array();
+		$columns  = array();
 		$table_parts = explode( '.', $table );
 		$table       = '`' . implode( '`.`', $table_parts ) . '`';
 		$results     = $this->get_results( "SHOW FULL COLUMNS FROM $table" );
 		if ( ! $results ) {
 			}
 			list( $type ) = explode( '(', $column->Type );
 			// A binary/blob means the whole query gets treated like this.
-			if ( in_array( strtoupper( $type ), array( 'BINARY', 'VARBINARY', 'TINYBLOB', 'MEDIUMBLOB', 'BLOB', 'LONGBLOB' ) ) ) {
+			if ( in_array( strtoupper( $type ), array( 'BINARY', 'VARBINARY', 'TINYBLOB', 'MEDIUMBLOB', 'BLOB', 'LONGBLOB' ), true ) ) {
 				$this->table_charset[ $tablekey ] = 'binary';
 				return 'binary';
 			}
 		}
 	 *
 	 * @since 4.2.0
 	 *
 	 * @param string $table  Table name.
 	 * @param string $column Column name.
-	 * @return string|false|WP_Error Column character set as a string. False if the column has no
+	 * @return string|false|WP_Error Column character set as a string. False if the column has
-	 *                               character set. WP_Error object if there was an error.
+	 *                               no character set. WP_Error object if there was an error.
 	 */
 	public function get_col_charset( $table, $column ) {
 		$tablekey  = strtolower( $table );
 		$columnkey = strtolower( $column );
 		 * Passing a non-null value to the filter will short-circuit
 		 * checking the DB for the charset, returning that value instead.
 		 *
 		 * @since 4.2.0
 		 *
-		 * @param string $charset The character set to use. Default null.
+		 * @param string|null $charset The character set to use. Default null.
-		 * @param string $table   The name of the table being checked.
+		 * @param string      $table   The name of the table being checked.
-		 * @param string $column  The name of the column being checked.
+		 * @param string      $column  The name of the column being checked.
 		 */
 		$charset = apply_filters( 'pre_get_col_charset', null, $table, $column );
 		if ( null !== $charset ) {
 			return $charset;
 		}
 		list( $charset ) = explode( '_', $this->col_meta[ $tablekey ][ $columnkey ]->Collation );
 		return $charset;
 	}
 	/**
-	 * Retrieve the maximum string length allowed in a given column.
+	 * Retrieves the maximum string length allowed in a given column.
+	 *
 	 * The length may either be specified as a byte length or a character length.
 	 *
 	 * @since 4.2.1
 	 *
 	 * @param string $table  Table name.
 	 * @param string $column Column name.
-	 * @return array|false|WP_Error array( 'length' => (int), 'type' => 'byte' | 'char' )
+	 * @return array|false|WP_Error array( 'length' => (int), 'type' => 'byte' | 'char' ).
-	 *                              false if the column has no length (for example, numeric column)
+	 *                              False if the column has no length (for example, numeric column).
 	 *                              WP_Error object if there was an error.
 	 */
 	public function get_col_length( $table, $column ) {
 		$tablekey  = strtolower( $table );
 		$columnkey = strtolower( $column );
 				return false;
 		}
 	}
 	/**
-	 * Check if a string is ASCII.
+	 * Checks if a string is ASCII.
 	 *
 	 * The negative regex is faster for non-ASCII strings, as it allows
 	 * the search to finish as soon as it encounters a non-ASCII character.
 	 *
 	 * @since 4.2.0
 		return false;
 	}
 	/**
-	 * Check 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 on the current version of MySQL.
 	 *
 	 * @since 4.2.0
 	 *
 	 * @param string $query The query to check.
 	 * @return bool True if the collation is safe, false if it isn't.
 	/**
 	 * Strips any invalid characters based on value/charset pairs.
 	 *
 	 * @since 4.2.0
 	 *
-	 * @param array $data Array of value arrays. Each value array has the keys
+	 * @param array $data Array of value arrays. Each value array has the keys 'value' and 'charset'.
-	 *                    'value' and 'charset'. An optional 'ascii' key can be
+	 *                    An optional 'ascii' key can be set to false to avoid redundant ASCII checks.
-	 *                    set to false to avoid redundant ASCII checks.
+	 * @return array|WP_Error The $data parameter, with invalid characters removed from each value.
-	 * @return array|WP_Error The $data parameter, with invalid characters removed from
+	 *                        This works as a passthrough: any additional keys such as 'field' are
-	 *                        each value. This works as a passthrough: any additional keys
+	 *                        retained in each value array. If we cannot remove invalid characters,
-	 *                        such as 'field' are retained in each value array. If we cannot
+	 *                        a WP_Error object is returned.
-	 *                        remove invalid characters, a WP_Error object is returned.
 	 */
 	protected function strip_invalid_text( $data ) {
 		$db_check_string = false;
 		foreach ( $data as &$value ) {
 			if ( is_array( $value['length'] ) ) {
 				$length                  = $value['length']['length'];
 				$truncate_by_byte_length = 'byte' === $value['length']['type'];
 			} else {
 				$length = false;
-				// Since we have no length, we'll never truncate.
+				// Since we have no length, we'll never truncate. Initialize the variable to false.
-				// Initialize the variable to false. true would take us
+				// True would take us through an unnecessary (for this case) codepath below.
-				// through an unnecessary (for this case) codepath below.
 				$truncate_by_byte_length = false;
 			}
 			// There's no charset to work with.
 			if ( false === $charset ) {
 				continue;
 			}
 			$needs_validation = true;
 			if (
-				// latin1 can store any byte sequence
+				// latin1 can store any byte sequence.
 				'latin1' === $charset
 			||
 				// ASCII is always OK.
 				( ! isset( $value['ascii'] ) && $this->check_ascii( $value['value'] ) )
 			) {
 				}
 				continue;
 			}
 			// We couldn't use any local conversions, send it to the DB.
-			$value['db'] = $db_check_string = true;
+			$value['db']     = true;
+			$db_check_string = true;
 		}
 		unset( $value ); // Remove by reference.
 		if ( $db_check_string ) {
 			$queries = array();
 			foreach ( $data as $col => $value ) {
 				if ( ! empty( $value['db'] ) ) {
 					// We're going to need to truncate by characters or bytes, depending on the length value we have.
-					if ( 'byte' === $value['length']['type'] ) {
+					if ( isset( $value['length']['type'] ) && 'byte' === $value['length']['type'] ) {
 						// Using binary causes LEFT() to truncate by bytes.
 						$charset = 'binary';
 					} else {
 						$charset = $value['charset'];
 					}
 			$charset = $this->get_table_charset( $table );
 			if ( is_wp_error( $charset ) ) {
 				return $charset;
 			}
-			// We can't reliably strip text from tables containing binary/blob columns
+			// We can't reliably strip text from tables containing binary/blob columns.
 			if ( 'binary' === $charset ) {
 				return $query;
 			}
 		} else {
 			$charset = $this->charset;
 		return $data[ $column ]['value'];
 	}
 	/**
-	 * Find the first table name referenced in a query.
+	 * Finds the first table name referenced in a query.
 	 *
 	 * @since 4.2.0
 	 *
 	 * @param string $query The query to search.
-	 * @return string|false $table The table name found, or false if a table couldn't be found.
+	 * @return string|false The table name found, or false if a table couldn't be found.
 	 */
 	protected function get_table_from_query( $query ) {
 		// Remove characters that can legally trail the table name.
 		$query = rtrim( $query, ';/-#' );
 		// SHOW TABLE STATUS and SHOW TABLES WHERE Name = 'wp_posts'
 		if ( preg_match( '/^\s*SHOW\s+(?:TABLE\s+STATUS|(?:FULL\s+)?TABLES).+WHERE\s+Name\s*=\s*("|\')((?:[0-9a-zA-Z$_.-]|[\xC2-\xDF][\x80-\xBF])+)\\1/is', $query, $maybe ) ) {
 			return $maybe[2];
 		}
-		// SHOW TABLE STATUS LIKE and SHOW TABLES LIKE 'wp\_123\_%'
+		/*
-		// This quoted LIKE operand seldom holds a full table name.
+		 * SHOW TABLE STATUS LIKE and SHOW TABLES LIKE 'wp\_123\_%'
-		// It is usually a pattern for matching a prefix so we just
+		 * This quoted LIKE operand seldom holds a full table name.
-		// strip the trailing % and unescape the _ to get 'wp_123_'
+		 * It is usually a pattern for matching a prefix so we just
-		// which drop-ins can use for routing these SQL statements.
+		 * strip the trailing % and unescape the _ to get 'wp_123_'
+		 * which drop-ins can use for routing these SQL statements.
+		 */
 		if ( preg_match( '/^\s*SHOW\s+(?:TABLE\s+STATUS|(?:FULL\s+)?TABLES)\s+(?:WHERE\s+Name\s+)?LIKE\s*("|\')((?:[\\\\0-9a-zA-Z$_.-]|[\xC2-\xDF][\x80-\xBF])+)%?\\1/is', $query, $maybe ) ) {
 			return str_replace( '\\_', '_', $maybe[2] );
 		}
 		// Big pattern for the rest of the table-related queries.
 		return false;
 	}
 	/**
-	 * Load the column metadata from the last query.
+	 * Loads the column metadata from the last query.
 	 *
 	 * @since 3.5.0
 	 */
 	protected function load_col_info() {
 		if ( $this->col_info ) {
 			}
 		}
 	}
 	/**
-	 * Retrieve column metadata from the last query.
+	 * Retrieves column metadata from the last query.
 	 *
 	 * @since 0.71
 	 *
-	 * @param string $info_type  Optional. Type one of name, table, def, max_length, not_null, primary_key, multiple_key, unique_key, numeric, blob, type, unsigned, zerofill
+	 * @param string $info_type  Optional. Possible values include 'name', 'table', 'def', 'max_length',
-	 * @param int    $col_offset Optional. 0: col name. 1: which table the col's in. 2: col's max length. 3: if the col is numeric. 4: col's type
+	 *                           'not_null', 'primary_key', 'multiple_key', 'unique_key', 'numeric',
-	 * @return mixed Column Results
+	 *                           'blob', 'type', 'unsigned', 'zerofill'. Default 'name'.
+	 * @param int    $col_offset Optional. 0: col name. 1: which table the col's in. 2: col's max length.
+	 *                           3: if the col is numeric. 4: col's type. Default -1.
+	 * @return mixed Column results.
 	 */
 	public function get_col_info( $info_type = 'name', $col_offset = -1 ) {
 		$this->load_col_info();
 		if ( $this->col_info ) {
-			if ( $col_offset == -1 ) {
+			if ( -1 === $col_offset ) {
 				$i         = 0;
 				$new_array = array();
 				foreach ( (array) $this->col_info as $col ) {
 					$new_array[ $i ] = $col->{$info_type};
 					$i++;
 	/**
 	 * Stops the debugging timer.
 	 *
 	 * @since 1.5.0
 	 *
-	 * @return float Total time spent on the query, in seconds
+	 * @return float Total time spent on the query, in seconds.
 	 */
 	public function timer_stop() {
 		return ( microtime( true ) - $this->time_start );
 	}
 	 *
 	 * Will not die if wpdb::$show_errors is false.
 	 *
 	 * @since 1.5.0
 	 *
-	 * @param string $message    The Error message
+	 * @param string $message    The error message.
-	 * @param string $error_code Optional. A Computer readable string to identify the error.
+	 * @param string $error_code Optional. A computer-readable string to identify the error.
-	 * @return false|void
+	 *                           Default '500'.
+	 * @return void|false Void if the showing of errors is enabled, false if disabled.
 	 */
 	public function bail( $message, $error_code = '500' ) {
 		if ( $this->show_errors ) {
 			$error = '';
 	/**
 	 * Closes the current database connection.
 	 *
 	 * @since 4.5.0
 	 *
-	 * @return bool True if the connection was successfully closed, false if it wasn't,
+	 * @return bool True if the connection was successfully closed,
-	 *              or the connection doesn't exist.
+	 *              false if it wasn't, or if the connection doesn't exist.
 	 */
 	public function close() {
 		if ( ! $this->dbh ) {
 			return false;
 		}
 		return $closed;
 	}
 	/**
-	 * Whether MySQL database is at least the required minimum version.
+	 * Determines whether MySQL database is at least the required minimum version.
 	 *
 	 * @since 2.5.0
 	 *
-	 * @global string $wp_version
+	 * @global string $wp_version             The WordPress version string.
-	 * @global string $required_mysql_version
+	 * @global string $required_mysql_version The required MySQL version string.
-	 *
+	 * @return void|WP_Error
-	 * @return WP_Error|void
 	 */
 	public function check_database_version() {
 		global $wp_version, $required_mysql_version;
-		// Make sure the server has the required MySQL version
+		// Make sure the server has the required MySQL version.
 		if ( version_compare( $this->db_version(), $required_mysql_version, '<' ) ) {
-			/* translators: 1: WordPress version number, 2: Minimum required MySQL version number */
+			/* translators: 1: WordPress version number, 2: Minimum required MySQL version number. */
-			return new WP_Error( 'database_version', sprintf( __( '<strong>ERROR</strong>: WordPress %1$s requires MySQL %2$s or higher' ), $wp_version, $required_mysql_version ) );
+			return new WP_Error( 'database_version', sprintf( __( '<strong>Error</strong>: WordPress %1$s requires MySQL %2$s or higher' ), $wp_version, $required_mysql_version ) );
 		}
 	}
 	/**
-	 * Whether the database supports collation.
+	 * Determines whether the database supports collation.
 	 *
 	 * Called when WordPress is generating the table scheme.
 	 *
 	 * Use `wpdb::has_cap( 'collation' )`.
 	 *
 	 * @since 2.5.0
 	 * @deprecated 3.5.0 Use wpdb::has_cap()
 	 *
-	 * @return bool True if collation is supported, false if version does not
+	 * @return bool True if collation is supported, false if not.
 	 */
 	public function supports_collation() {
 		_deprecated_function( __FUNCTION__, '3.5.0', 'wpdb::has_cap( \'collation\' )' );
 		return $this->has_cap( 'collation' );
 	}
 	/**
-	 * The database character collate.
+	 * Retrieves the database character collate.
 	 *
 	 * @since 3.5.0
 	 *
 	 * @return string The database character collate.
 	 */
 		return $charset_collate;
 	}
 	/**
-	 * Determine if a database supports a particular feature.
+	 * Determines if a database supports a particular feature.
 	 *
 	 * @since 2.7.0
 	 * @since 4.1.0 Added support for the 'utf8mb4' feature.
 	 * @since 4.6.0 Added support for the 'utf8mb4_520' feature.
 	 *
 	 * @see wpdb::db_version()
 	 *
-	 * @param string $db_cap The feature to check for. Accepts 'collation',
+	 * @param string $db_cap The feature to check for. Accepts 'collation', 'group_concat',
-	 *                       'group_concat', 'subqueries', 'set_charset',
+	 *                       'subqueries', 'set_charset', 'utf8mb4', or 'utf8mb4_520'.
-	 *                       'utf8mb4', or 'utf8mb4_520'.
 	 * @return int|false Whether the database feature is supported, false otherwise.
 	 */
 	public function has_cap( $db_cap ) {
 		$version = $this->db_version();
 		return false;
 	}
 	/**
-	 * Retrieve the name of the function that called wpdb.
+	 * Retrieves the name of the function that called wpdb.
 	 *
-	 * Searches up the list of functions until it reaches
+	 * Searches up the list of functions until it reaches the one that would
-	 * the one that would most logically had called this method.
+	 * most logically had called this method.
 	 *
 	 * @since 2.5.0
 	 *
-	 * @return string Comma separated list of the calling functions.
+	 * @return string Comma-separated list of the calling functions.
 	 */
 	public function get_caller() {
 		return wp_debug_backtrace_summary( __CLASS__ );
 	}
 	/**
 	 * Retrieves the MySQL server version.
 	 *
 	 * @since 2.7.0
 	 *
-	 * @return null|string Null on failure, version number on success.
+	 * @return string|null Version number on success, null on failure.
 	 */
 	public function db_version() {
+		return preg_replace( '/[^0-9.].*/', '', $this->db_server_info() );
+	}
+	/**
+	 * Retrieves full MySQL server information.
+	 *
+	 * @since 5.5.0
+	 *
+	 * @return string|false Server info on success, false on failure.
+	 */
+	public function db_server_info() {
 		if ( $this->use_mysqli ) {
 			$server_info = mysqli_get_server_info( $this->dbh );
 		} else {
 			$server_info = mysql_get_server_info( $this->dbh );
 		}
-		return preg_replace( '/[^0-9.].*/', '', $server_info );
+		return $server_info;
 	}
 }

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a