/**
* @since 0.71
*/
-define( 'OBJECT', 'OBJECT', true );
+define( 'OBJECT', 'OBJECT' );
+define( 'object', 'OBJECT' ); // Back compat.
/**
* @since 2.5.0
*
* It is possible to replace this class with your own
* by setting the $wpdb global variable in wp-content/db.php
- * file with your class. You can name it wpdb also, since
- * this file will not be included, if the other file is
- * available.
+ * file to your class. The wpdb class will still be included,
+ * so you can extend it or simply use your own.
*
* @link http://codex.wordpress.org/Function_Reference/wpdb_Class
*
class wpdb {
/**
- * Whether to show SQL/DB errors
+ * Whether to show SQL/DB errors.
+ *
+ * Default behavior is to show errors if both WP_DEBUG and WP_DEBUG_DISPLAY
+ * evaluated to true.
*
* @since 0.71
* @access private
/**
* The last error during query.
*
- * @see get_last_error()
* @since 2.5.0
- * @access private
* @var string
*/
- var $last_error = '';
+ public $last_error = '';
/**
* Amount of queries made
/**
* Count of rows returned by previous query
*
- * @since 1.2.0
+ * @since 0.71
* @access private
* @var int
*/
var $insert_id = 0;
/**
- * Saved result of the last query made
+ * Last query made
*
- * @since 1.2.0
+ * @since 0.71
* @access private
* @var array
*/
/**
* Results of the last query made
*
- * @since 1.0.0
+ * @since 0.71
* @access private
* @var array|null
*/
var $last_result;
+ /**
+ * MySQL result, which is either a resource or boolean.
+ *
+ * @since 0.71
+ * @access protected
+ * @var mixed
+ */
+ protected $result;
+
/**
* Saved info on the table column
*
- * @since 1.2.0
- * @access private
+ * @since 0.71
+ * @access protected
* @var array
*/
- var $col_info;
+ protected $col_info;
/**
* Saved queries that were executed
*/
var $queries;
+ /**
+ * The number of times to retry reconnecting before dying.
+ *
+ * @since 3.9.0
+ * @access protected
+ * @see wpdb::check_connection()
+ * @var int
+ */
+ protected $reconnect_retries = 5;
+
/**
* WordPress table prefix
*
* in a single database. The second reason is for possible
* security precautions.
*
- * @since 0.71
+ * @since 2.5.0
* @access private
* @var string
*/
var $prefix = '';
+ /**
+ * WordPress base table prefix.
+ *
+ * @since 3.0.0
+ * @access public
+ * @var string
+ */
+ public $base_prefix;
+
/**
* Whether the database queries are ready to start executing.
*
- * @since 2.5.0
+ * @since 2.3.2
* @access private
* @var bool
*/
* @access public
* @var int
*/
- var $blogid = 0;
+ public $blogid = 0;
/**
* {@internal Missing Description}}
* @access public
* @var int
*/
- var $siteid = 0;
+ public $siteid = 0;
/**
* List of WordPress per-blog tables
* @access public
* @var string
*/
- var $comments;
+ public $comments;
/**
* WordPress Comment Metadata table
* @access public
* @var string
*/
- var $commentmeta;
+ public $commentmeta;
/**
* WordPress Links table
* @access public
* @var string
*/
- var $links;
+ public $links;
/**
* WordPress Options table
* @access public
* @var string
*/
- var $options;
+ public $options;
/**
* WordPress Post Metadata table
* @access public
* @var string
*/
- var $postmeta;
+ public $postmeta;
/**
* WordPress Posts table
* @access public
* @var string
*/
- var $posts;
+ public $posts;
/**
* WordPress Terms table
* @access public
* @var string
*/
- var $terms;
+ public $terms;
/**
* WordPress Term Relationships table
* @access public
* @var string
*/
- var $term_relationships;
+ public $term_relationships;
/**
* WordPress Term Taxonomy table
* @access public
* @var string
*/
- var $term_taxonomy;
+ public $term_taxonomy;
/*
* Global and Multisite tables
* @access public
* @var string
*/
- var $usermeta;
+ public $usermeta;
/**
* WordPress Users table
* @access public
* @var string
*/
- var $users;
+ public $users;
/**
* Multisite Blogs table
* @access public
* @var string
*/
- var $blogs;
+ public $blogs;
/**
* Multisite Blog Versions table
* @access public
* @var string
*/
- var $blog_versions;
+ public $blog_versions;
/**
* Multisite Registration Log table
* @access public
* @var string
*/
- var $registration_log;
+ public $registration_log;
/**
* Multisite Signups table
* @access public
* @var string
*/
- var $signups;
+ public $signups;
/**
* Multisite Sites table
* @access public
* @var string
*/
- var $site;
+ public $site;
/**
* Multisite Sitewide Terms table
* @access public
* @var string
*/
- var $sitecategories;
+ public $sitecategories;
/**
* Multisite Site Metadata table
* @access public
* @var string
*/
- var $sitemeta;
+ public $sitemeta;
/**
* Format specifiers for DB columns. 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()
+ * @see wpdb::prepare()
+ * @see wpdb::insert()
+ * @see wpdb::update()
+ * @see wpdb::delete()
* @see wp_set_wpdb_vars()
* @access public
* @var array
*/
- var $field_types = array();
+ public $field_types = array();
/**
* Database table columns charset
* @access public
* @var string
*/
- var $charset;
+ public $charset;
/**
* Database table columns collate
* @access public
* @var string
*/
- var $collate;
+ public $collate;
/**
- * Whether to use mysql_real_escape_string
+ * Database Username
*
- * @since 2.8.0
- * @access public
- * @var bool
+ * @since 2.9.0
+ * @access protected
+ * @var string
*/
- var $real_escape = false;
+ protected $dbuser;
/**
- * Database Username
+ * Database Password
*
- * @since 2.9.0
- * @access private
+ * @since 3.1.0
+ * @access protected
* @var string
*/
- var $dbuser;
+ protected $dbpassword;
+
+ /**
+ * Database Name
+ *
+ * @since 3.1.0
+ * @access protected
+ * @var string
+ */
+ protected $dbname;
+
+ /**
+ * Database Host
+ *
+ * @since 3.1.0
+ * @access protected
+ * @var string
+ */
+ protected $dbhost;
+
+ /**
+ * Database Handle
+ *
+ * @since 0.71
+ * @access protected
+ * @var string
+ */
+ protected $dbh;
/**
* A textual description of the last query/get_row/get_var call
* @access public
* @var string
*/
- var $func_call;
+ public $func_call;
/**
- * Connects to the database server and selects a database
+ * Whether MySQL is used as the database engine.
*
- * PHP4 compatibility layer for calling the PHP5 constructor.
+ * 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.
*
- * @uses wpdb::__construct() Passes parameters and returns result
- * @since 0.71
+ * @since 3.3.0
+ * @access public
+ * @var bool
+ */
+ public $is_mysql = null;
+
+ /**
+ * A list of incompatible SQL modes.
*
- * @param string $dbuser MySQL database user
- * @param string $dbpassword MySQL database password
- * @param string $dbname MySQL database name
- * @param string $dbhost MySQL database host
+ * @since 3.9.0
+ * @access protected
+ * @var array
*/
- function wpdb( $dbuser, $dbpassword, $dbname, $dbhost ) {
- return $this->__construct( $dbuser, $dbpassword, $dbname, $dbhost );
- }
+ protected $incompatible_modes = array( 'NO_ZERO_DATE', 'ONLY_FULL_GROUP_BY',
+ 'STRICT_TRANS_TABLES', 'STRICT_ALL_TABLES', 'TRADITIONAL' );
+
+ /**
+ * Whether to use mysqli over mysql.
+ *
+ * @since 3.9.0
+ * @access private
+ * @var bool
+ */
+ private $use_mysqli = false;
+
+ /**
+ * Whether we've managed to successfully connect at some point
+ *
+ * @since 3.9.0
+ * @access private
+ * @var bool
+ */
+ private $has_connected = false;
/**
* Connects to the database server and selects a database
* @param string $dbname MySQL database name
* @param string $dbhost MySQL database host
*/
- function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) {
- register_shutdown_function( array( &$this, '__destruct' ) );
+ public function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) {
+ register_shutdown_function( array( $this, '__destruct' ) );
- if ( WP_DEBUG )
+ if ( WP_DEBUG && WP_DEBUG_DISPLAY )
$this->show_errors();
+ /* Use ext/mysqli if it exists and:
+ * - WP_USE_EXT_MYSQL is defined as false, or
+ * - We are a development version of WordPress, or
+ * - We are running PHP 5.5 or greater, or
+ * - ext/mysql is not loaded.
+ */
+ if ( function_exists( 'mysqli_connect' ) ) {
+ if ( defined( 'WP_USE_EXT_MYSQL' ) ) {
+ $this->use_mysqli = ! WP_USE_EXT_MYSQL;
+ } elseif ( version_compare( phpversion(), '5.5', '>=' ) || ! function_exists( 'mysql_connect' ) ) {
+ $this->use_mysqli = true;
+ } elseif ( false !== strpos( $GLOBALS['wp_version'], '-' ) ) {
+ $this->use_mysqli = true;
+ }
+ }
+
$this->init_charset();
$this->dbuser = $dbuser;
$this->dbname = $dbname;
$this->dbhost = $dbhost;
+ // wp-config.php creation will manually connect when ready.
+ if ( defined( 'WP_SETUP_CONFIG' ) ) {
+ return;
+ }
+
$this->db_connect();
}
* @since 2.0.8
* @return bool true
*/
- function __destruct() {
+ public function __destruct() {
return true;
}
+ /**
+ * PHP5 style magic getter, used to lazy-load expensive data.
+ *
+ * @since 3.5.0
+ *
+ * @param string $name The private member to get, and optionally process
+ * @return mixed The private member
+ */
+ public function __get( $name ) {
+ if ( 'col_info' == $name )
+ $this->load_col_info();
+
+ return $this->$name;
+ }
+
+ /**
+ * Magic function, for backwards compatibility.
+ *
+ * @since 3.5.0
+ *
+ * @param string $name The private member to set
+ * @param mixed $value The value to set
+ */
+ public function __set( $name, $value ) {
+ $this->$name = $value;
+ }
+
+ /**
+ * Magic function, for backwards compatibility.
+ *
+ * @since 3.5.0
+ *
+ * @param string $name The private member to check
+ *
+ * @return bool If the member is set or not
+ */
+ public function __isset( $name ) {
+ return isset( $this->$name );
+ }
+
+ /**
+ * Magic function, for backwards compatibility.
+ *
+ * @since 3.5.0
+ *
+ * @param string $name The private member to unset
+ */
+ public function __unset( $name ) {
+ unset( $this->$name );
+ }
+
/**
* Set $this->charset and $this->collate
*
* @since 3.1.0
*/
- function init_charset() {
+ public function init_charset() {
if ( function_exists('is_multisite') && is_multisite() ) {
$this->charset = 'utf8';
if ( defined( 'DB_COLLATE' ) && DB_COLLATE )
* @param string $charset The character set (optional)
* @param string $collate The collation (optional)
*/
- function set_charset($dbh, $charset = null, $collate = null) {
- if ( !isset($charset) )
+ public function set_charset( $dbh, $charset = null, $collate = null ) {
+ if ( ! isset( $charset ) )
$charset = $this->charset;
- if ( !isset($collate) )
+ if ( ! isset( $collate ) )
$collate = $this->collate;
- if ( $this->has_cap( 'collation', $dbh ) && !empty( $charset ) ) {
- if ( function_exists( 'mysql_set_charset' ) && $this->has_cap( 'set_charset', $dbh ) ) {
- mysql_set_charset( $charset, $dbh );
- $this->real_escape = true;
+ if ( $this->has_cap( 'collation' ) && ! empty( $charset ) ) {
+ if ( $this->use_mysqli ) {
+ if ( function_exists( 'mysqli_set_charset' ) && $this->has_cap( 'set_charset' ) ) {
+ mysqli_set_charset( $dbh, $charset );
+ } else {
+ $query = $this->prepare( 'SET NAMES %s', $charset );
+ if ( ! empty( $collate ) )
+ $query .= $this->prepare( ' COLLATE %s', $collate );
+ mysqli_query( $query, $dbh );
+ }
+ } else {
+ if ( function_exists( 'mysql_set_charset' ) && $this->has_cap( 'set_charset' ) ) {
+ mysql_set_charset( $charset, $dbh );
+ } else {
+ $query = $this->prepare( 'SET NAMES %s', $charset );
+ if ( ! empty( $collate ) )
+ $query .= $this->prepare( ' COLLATE %s', $collate );
+ mysql_query( $query, $dbh );
+ }
+ }
+ }
+ }
+
+ /**
+ * Change the current SQL mode, and ensure its WordPress compatibility.
+ *
+ * If no modes are passed, it will ensure the current MySQL server
+ * modes are compatible.
+ *
+ * @since 3.9.0
+ *
+ * @param array $modes Optional. A list of SQL modes to set.
+ */
+ public function set_sql_mode( $modes = array() ) {
+ if ( empty( $modes ) ) {
+ if ( $this->use_mysqli ) {
+ $res = mysqli_query( $this->dbh, 'SELECT @@SESSION.sql_mode' );
+ } else {
+ $res = mysql_query( 'SELECT @@SESSION.sql_mode', $this->dbh );
+ }
+
+ if ( empty( $res ) ) {
+ return;
+ }
+
+ if ( $this->use_mysqli ) {
+ $modes_array = mysqli_fetch_array( $res );
+ if ( empty( $modes_array[0] ) ) {
+ return;
+ }
+ $modes_str = $modes_array[0];
} else {
- $query = $this->prepare( 'SET NAMES %s', $charset );
- if ( ! empty( $collate ) )
- $query .= $this->prepare( ' COLLATE %s', $collate );
- mysql_query( $query, $dbh );
+ $modes_str = mysql_result( $res, 0 );
}
+
+ if ( empty( $modes_str ) ) {
+ return;
+ }
+
+ $modes = explode( ',', $modes_str );
+ }
+
+ $modes = array_change_key_case( $modes, CASE_UPPER );
+
+ /**
+ * Filter the list of incompatible SQL modes to exclude.
+ *
+ * @since 3.9.0
+ *
+ * @see wpdb::$incompatible_modes
+ *
+ * @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 ) ) {
+ unset( $modes[ $i ] );
+ }
+ }
+
+ $modes_str = implode( ',', $modes );
+
+ if ( $this->use_mysqli ) {
+ mysqli_query( $this->dbh, "SET SESSION sql_mode='$modes_str'" );
+ } else {
+ mysql_query( "SET SESSION sql_mode='$modes_str'", $this->dbh );
}
}
* @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.
* @return string|WP_Error Old prefix or WP_Error on error
*/
- function set_prefix( $prefix, $set_table_names = true ) {
+ public function set_prefix( $prefix, $set_table_names = true ) {
if ( preg_match( '|[^a-z0-9_]|i', $prefix ) )
- return new WP_Error('invalid_db_prefix', /*WP_I18N_DB_BAD_PREFIX*/'Invalid database prefix'/*/WP_I18N_DB_BAD_PREFIX*/);
+ return new WP_Error('invalid_db_prefix', 'Invalid database prefix' );
$old_prefix = is_multisite() ? '' : $prefix;
* @param int $site_id Optional.
* @return string previous blog id
*/
- function set_blog_id( $blog_id, $site_id = 0 ) {
+ public function set_blog_id( $blog_id, $site_id = 0 ) {
if ( ! empty( $site_id ) )
$this->siteid = $site_id;
* @param int $blog_id Optional.
* @return string Blog prefix.
*/
- function get_blog_prefix( $blog_id = null ) {
+ 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 ) )
return $this->base_prefix;
else
* Returns an array of WordPress tables.
*
* Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
- * override the WordPress users and usersmeta tables that would otherwise
+ * override the WordPress users and usermeta tables that would otherwise
* be determined by the prefix.
*
* The scope argument can take one of the following:
* @param int $blog_id Optional. The blog_id to prefix. Defaults to wpdb::$blogid. Used only when prefix is requested.
* @return array Table names. When a prefix is requested, the key is the unprefixed table name.
*/
- function tables( $scope = 'all', $prefix = true, $blog_id = 0 ) {
+ public function tables( $scope = 'all', $prefix = true, $blog_id = 0 ) {
switch ( $scope ) {
case 'all' :
$tables = array_merge( $this->global_tables, $this->tables );
break;
default :
return array();
- break;
}
if ( $prefix ) {
* @param resource $dbh Optional link identifier.
* @return null Always null.
*/
- function select( $db, $dbh = null) {
+ public function select( $db, $dbh = null ) {
if ( is_null($dbh) )
$dbh = $this->dbh;
- if ( !@mysql_select_db( $db, $dbh ) ) {
+ if ( $this->use_mysqli ) {
+ $success = @mysqli_select_db( $dbh, $db );
+ } else {
+ $success = @mysql_select_db( $db, $dbh );
+ }
+ if ( ! $success ) {
$this->ready = false;
- $this->bail( sprintf( /*WP_I18N_DB_SELECT_DB*/'<h1>Can’t select database</h1>
+ if ( ! did_action( 'template_redirect' ) ) {
+ wp_load_translations_early();
+ $this->bail( sprintf( __( '<h1>Can’t select database</h1>
<p>We were able to connect to the database server (which means your username and password is okay) but not able to select the <code>%1$s</code> database.</p>
<ul>
<li>Are you sure it exists?</li>
<li>Does the user <code>%2$s</code> have permission to use the <code>%1$s</code> database?</li>
<li>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?</li>
</ul>
-<p>If you don\'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="http://wordpress.org/support/">WordPress Support Forums</a>.</p>'/*/WP_I18N_DB_SELECT_DB*/, $db, $this->dbuser ), 'db_select_fail' );
+<p>If you don\'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="https://wordpress.org/support/">WordPress Support Forums</a>.</p>' ), htmlspecialchars( $db, ENT_QUOTES ), htmlspecialchars( $this->dbuser, ENT_QUOTES ) ), 'db_select_fail' );
+ }
return;
}
}
/**
- * Weak escape, using addslashes()
+ * Do not use, deprecated.
+ *
+ * Use esc_sql() or wpdb::prepare() instead.
*
- * @see addslashes()
* @since 2.8.0
+ * @deprecated 3.6.0
+ * @see wpdb::prepare
+ * @see esc_sql()
* @access private
*
* @param string $string
* @return string
*/
function _weak_escape( $string ) {
+ if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) )
+ _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' );
return addslashes( $string );
}
/**
- * Real escape, using mysql_real_escape_string() or addslashes()
+ * Real escape, using mysqli_real_escape_string() or mysql_real_escape_string()
*
+ * @see mysqli_real_escape_string()
* @see mysql_real_escape_string()
- * @see addslashes()
* @since 2.8.0
* @access private
*
* @return string escaped
*/
function _real_escape( $string ) {
- if ( $this->dbh && $this->real_escape )
- return mysql_real_escape_string( $string, $this->dbh );
- else
- return addslashes( $string );
+ if ( $this->dbh ) {
+ if ( $this->use_mysqli ) {
+ return mysqli_real_escape_string( $this->dbh, $string );
+ } else {
+ return mysql_real_escape_string( $string, $this->dbh );
+ }
+ }
+
+ $class = get_class( $this );
+ _doing_it_wrong( $class, "$class must set a database connection for use with escaping.", E_USER_NOTICE );
+ return addslashes( $string );
}
/**
* Escape data. Works on arrays.
*
- * @uses wpdb::_escape()
* @uses wpdb::_real_escape()
* @since 2.8.0
* @access private
*/
function _escape( $data ) {
if ( is_array( $data ) ) {
- foreach ( (array) $data as $k => $v ) {
+ foreach ( $data as $k => $v ) {
if ( is_array($v) )
$data[$k] = $this->_escape( $v );
else
}
/**
- * Escapes content for insertion into the database using addslashes(), for security.
+ * Do not use, deprecated.
*
- * Works on arrays.
+ * Use esc_sql() or wpdb::prepare() instead.
*
* @since 0.71
- * @param string|array $data to escape
- * @return string|array escaped as query safe string
+ * @deprecated 3.6.0
+ * @see wpdb::prepare()
+ * @see esc_sql()
+ *
+ * @param mixed $data
+ * @return mixed
*/
- function escape( $data ) {
+ public function escape( $data ) {
+ if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) )
+ _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' );
if ( is_array( $data ) ) {
- foreach ( (array) $data as $k => $v ) {
+ foreach ( $data as $k => $v ) {
if ( is_array( $v ) )
- $data[$k] = $this->escape( $v );
+ $data[$k] = $this->escape( $v, 'recursive' );
else
- $data[$k] = $this->_weak_escape( $v );
+ $data[$k] = $this->_weak_escape( $v, 'internal' );
}
} else {
- $data = $this->_weak_escape( $data );
+ $data = $this->_weak_escape( $data, 'internal' );
}
return $data;
* @param string $string to escape
* @return void
*/
- function escape_by_ref( &$string ) {
- $string = $this->_real_escape( $string );
+ 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.
*
* The following directives can be used in the query format string:
- * %d (decimal number)
+ * %d (integer)
+ * %f (float)
* %s (string)
* %% (literal percentage sign - no argument needed)
*
- * Both %d and %s are to be left unquoted in the query string and they need an argument passed for them.
+ * All of %d, %f, and %s are to be left unquoted in the query string and they need an argument passed for them.
* Literals (%) as parts of the query must be properly written as %%.
*
- * This function only supports a small subset of the sprintf syntax; it only supports %d (decimal number), %s (string).
+ * This function only supports a small subset of the sprintf syntax; it only supports %d (integer), %f (float), and %s (string).
* Does not support sign, padding, alignment, width or precision specifiers.
* Does not support argument numbering/swapping.
*
* @return null|false|string Sanitized query string, null if there is no query, false if there is an error and string
* if there was something to prepare
*/
- function prepare( $query = null ) { // ( $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 ) {
+ _doing_it_wrong( 'wpdb::prepare', sprintf( __( 'The query argument of %s must have a placeholder.' ), 'wpdb::prepare()' ), '3.9' );
+ }
+
$args = func_get_args();
array_shift( $args );
// If args were passed as an array (as in vsprintf), move them up
$args = $args[0];
$query = str_replace( "'%s'", '%s', $query ); // in case someone mistakenly already singlequoted it
$query = str_replace( '"%s"', '%s', $query ); // doublequote unquoting
+ $query = preg_replace( '|(?<!%)%f|' , '%F', $query ); // Force floats to be locale unaware
$query = preg_replace( '|(?<!%)%s|', "'%s'", $query ); // quote the strings, avoiding escaped strings like %%s
- array_walk( $args, array( &$this, 'escape_by_ref' ) );
+ array_walk( $args, array( $this, 'escape_by_ref' ) );
return @vsprintf( $query, $args );
}
+ /**
+ * 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.
+ *
+ * Example Prepared Statement:
+ * $wild = '%';
+ * $find = 'only 43% of planets';
+ * $like = $wild . $wpdb->esc_like( $find ) . $wild;
+ * $sql = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE %s", $like );
+ *
+ * Example Escape Chain:
+ * $sql = esc_sql( $wpdb->esc_like( $input ) );
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $text The raw text to be escaped. The input typed by the user 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()
+ * or real_escape next.
+ */
+ public function esc_like( $text ) {
+ return addcslashes( $text, '_%\\' );
+ }
+
/**
* Print SQL/DB error.
*
* @param string $str The error to display
* @return bool False if the showing of errors is disabled.
*/
- function print_error( $str = '' ) {
+ public function print_error( $str = '' ) {
global $EZSQL_ERROR;
- if ( !$str )
- $str = mysql_error( $this->dbh );
+ if ( !$str ) {
+ if ( $this->use_mysqli ) {
+ $str = mysqli_error( $this->dbh );
+ } else {
+ $str = mysql_error( $this->dbh );
+ }
+ }
$EZSQL_ERROR[] = array( 'query' => $this->last_query, 'error_str' => $str );
if ( $this->suppress_errors )
return false;
+ wp_load_translations_early();
+
if ( $caller = $this->get_caller() )
- $error_str = sprintf( /*WP_I18N_DB_QUERY_ERROR_FULL*/'WordPress database error %1$s for query %2$s made by %3$s'/*/WP_I18N_DB_QUERY_ERROR_FULL*/, $str, $this->last_query, $caller );
+ $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s made by %3$s' ), $str, $this->last_query, $caller );
else
- $error_str = sprintf( /*WP_I18N_DB_QUERY_ERROR*/'WordPress database error %1$s for query %2$s'/*/WP_I18N_DB_QUERY_ERROR*/, $str, $this->last_query );
+ $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s' ), $str, $this->last_query );
- if ( function_exists( 'error_log' )
- && ( $log_file = @ini_get( 'error_log' ) )
- && ( 'syslog' == $log_file || @is_writable( $log_file ) )
- )
- @error_log( $error_str );
+ error_log( $error_str );
// Are we showing errors?
if ( ! $this->show_errors )
* @param bool $show Whether to show or hide errors
* @return bool Old value for showing errors.
*/
- function show_errors( $show = true ) {
+ public function show_errors( $show = true ) {
$errors = $this->show_errors;
$this->show_errors = $show;
return $errors;
*
* @return bool Whether showing of errors was active
*/
- function hide_errors() {
+ public function hide_errors() {
$show = $this->show_errors;
$this->show_errors = false;
return $show;
* @param bool $suppress Optional. New value. Defaults to true.
* @return bool Old value
*/
- function suppress_errors( $suppress = true ) {
+ public function suppress_errors( $suppress = true ) {
$errors = $this->suppress_errors;
$this->suppress_errors = (bool) $suppress;
return $errors;
* @since 0.71
* @return void
*/
- function flush() {
+ public function flush() {
$this->last_result = array();
$this->col_info = null;
$this->last_query = null;
+ $this->rows_affected = $this->num_rows = 0;
+ $this->last_error = '';
+
+ if ( is_resource( $this->result ) ) {
+ if ( $this->use_mysqli ) {
+ mysqli_free_result( $this->result );
+ } else {
+ mysql_free_result( $this->result );
+ }
+ }
}
/**
- * Connect to and select database
+ * Connect to and select database.
+ *
+ * If $allow_bail is false, the lack of database connection will need
+ * to be handled manually.
*
* @since 3.0.0
- */
- function db_connect() {
- global $db_list, $global_db_list;
+ * @since 3.9.0 $allow_bail parameter added.
+ *
+ * @param bool $allow_bail Optional. Allows the function to bail. Default true.
+ * @return bool True with a successful connection, false on failure.
+ */
+ public function db_connect( $allow_bail = true ) {
+
+ $this->is_mysql = true;
+
+ /*
+ * Deprecated in 3.9+ when using MySQLi. No equivalent
+ * $new_link parameter exists for mysqli_* functions.
+ */
+ $new_link = defined( 'MYSQL_NEW_LINK' ) ? MYSQL_NEW_LINK : true;
+ $client_flags = defined( 'MYSQL_CLIENT_FLAGS' ) ? MYSQL_CLIENT_FLAGS : 0;
+
+ if ( $this->use_mysqli ) {
+ $this->dbh = mysqli_init();
+
+ // mysqli_real_connect doesn't support the host param including a port or socket
+ // like mysql_connect does. This duplicates how mysql_connect detects a port and/or socket file.
+ $port = null;
+ $socket = null;
+ $host = $this->dbhost;
+ $port_or_socket = strstr( $host, ':' );
+ if ( ! empty( $port_or_socket ) ) {
+ $host = substr( $host, 0, strpos( $host, ':' ) );
+ $port_or_socket = substr( $port_or_socket, 1 );
+ if ( 0 !== strpos( $port_or_socket, '/' ) ) {
+ $port = intval( $port_or_socket );
+ $maybe_socket = strstr( $port_or_socket, ':' );
+ if ( ! empty( $maybe_socket ) ) {
+ $socket = substr( $maybe_socket, 1 );
+ }
+ } else {
+ $socket = $port_or_socket;
+ }
+ }
- if ( WP_DEBUG ) {
- $this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, true );
+ if ( WP_DEBUG ) {
+ mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
+ } else {
+ @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
+ * - WP_USE_EXT_MYSQL isn't set to false, and
+ * - ext/mysql is loaded.
+ */
+ $attempt_fallback = true;
+
+ if ( $this->has_connected ) {
+ $attempt_fallback = false;
+ } else if ( defined( 'WP_USE_EXT_MYSQL' ) && ! WP_USE_EXT_MYSQL ) {
+ $attempt_fallback = false;
+ } else if ( ! function_exists( 'mysql_connect' ) ) {
+ $attempt_fallback = false;
+ }
+
+ if ( $attempt_fallback ) {
+ $this->use_mysqli = false;
+ $this->db_connect();
+ }
+ }
} else {
- $this->dbh = @mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, true );
+ if ( WP_DEBUG ) {
+ $this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
+ } else {
+ $this->dbh = @mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
+ }
}
- if ( !$this->dbh ) {
- $this->bail( sprintf( /*WP_I18N_DB_CONN_ERROR*/"
+ 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' );
+ die();
+ }
+
+ $this->bail( sprintf( __( "
<h1>Error establishing a database connection</h1>
<p>This either means that the username and password information in your <code>wp-config.php</code> file is incorrect or we can't contact the database server at <code>%s</code>. This could mean your host's database server is down.</p>
<ul>
<li>Are you sure that you have typed the correct hostname?</li>
<li>Are you sure that the database server is running?</li>
</ul>
-<p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='http://wordpress.org/support/'>WordPress Support Forums</a>.</p>
-"/*/WP_I18N_DB_CONN_ERROR*/, $this->dbhost ), 'db_connect_fail' );
+<p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='https://wordpress.org/support/'>WordPress Support Forums</a>.</p>
+" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' );
- return;
+ return false;
+ } else if ( $this->dbh ) {
+ $this->has_connected = true;
+ $this->set_charset( $this->dbh );
+ $this->set_sql_mode();
+ $this->ready = true;
+ $this->select( $this->dbname, $this->dbh );
+
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Check 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
+ * the template_redirect hook has been fired, return false instead.
+ *
+ * If $allow_bail is false, the lack of database connection will need
+ * to be handled manually.
+ *
+ * @since 3.9.0
+ *
+ * @param bool $allow_bail Optional. Allows the function to bail. Default true.
+ * @return bool True if the connection is up.
+ */
+ public function check_connection( $allow_bail = true ) {
+ if ( $this->use_mysqli ) {
+ if ( @mysqli_ping( $this->dbh ) ) {
+ return true;
+ }
+ } else {
+ if ( @mysql_ping( $this->dbh ) ) {
+ return true;
+ }
}
- $this->set_charset( $this->dbh );
+ $error_reporting = false;
- $this->ready = true;
+ // 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 );
+ }
- $this->select( $this->dbname, $this->dbh );
+ for ( $tries = 1; $tries <= $this->reconnect_retries; $tries++ ) {
+ // On the last try, re-enable warnings. We want to see a single instance of the
+ // "unable to connect" message on the bail() screen, if it appears.
+ if ( $this->reconnect_retries === $tries && WP_DEBUG ) {
+ error_reporting( $error_reporting );
+ }
+
+ if ( $this->db_connect( false ) ) {
+ if ( $error_reporting ) {
+ error_reporting( $error_reporting );
+ }
+
+ return true;
+ }
+
+ sleep( 1 );
+ }
+
+ // If template_redirect has already happened, it's too late for wp_die()/dead_db().
+ // Let's just return and hope for the best.
+ if ( did_action( 'template_redirect' ) ) {
+ return false;
+ }
+
+ if ( ! $allow_bail ) {
+ return false;
+ }
+
+ // We weren't able to reconnect, so we better bail.
+ $this->bail( sprintf( ( "
+<h1>Error reconnecting to the database</h1>
+<p>This means that we lost contact with the database server at <code>%s</code>. This could mean your host's database server is down.</p>
+<ul>
+ <li>Are you sure that the database server is running?</li>
+ <li>Are you sure that the database server is not under particularly heavy load?</li>
+</ul>
+<p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='https://wordpress.org/support/'>WordPress Support Forums</a>.</p>
+" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), '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).
+ dead_db();
}
/**
* @param string $query Database query
* @return int|false Number of rows affected/selected or false on error
*/
- function query( $query ) {
+ public function query( $query ) {
if ( ! $this->ready )
return false;
- // some queries are made before the plugins have been loaded, and thus cannot be filtered with this method
- if ( function_exists( 'apply_filters' ) )
- $query = apply_filters( 'query', $query );
+ /**
+ * Filter the database query.
+ *
+ * Some queries are made before the plugins have been loaded,
+ * and thus cannot be filtered with this method.
+ *
+ * @since 2.1.0
+ *
+ * @param string $query Database query.
+ */
+ $query = apply_filters( 'query', $query );
- $return_val = 0;
$this->flush();
// Log how the function was called
// Keep track of the last query for debug..
$this->last_query = $query;
- if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES )
- $this->timer_start();
+ $this->_do_query( $query );
- $this->result = @mysql_query( $query, $this->dbh );
- $this->num_queries++;
+ // MySQL server has gone away, try to reconnect
+ $mysql_errno = 0;
+ if ( ! empty( $this->dbh ) ) {
+ if ( $this->use_mysqli ) {
+ $mysql_errno = mysqli_errno( $this->dbh );
+ } else {
+ $mysql_errno = mysql_errno( $this->dbh );
+ }
+ }
- if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES )
- $this->queries[] = array( $query, $this->timer_stop(), $this->get_caller() );
+ if ( empty( $this->dbh ) || 2006 == $mysql_errno ) {
+ if ( $this->check_connection() ) {
+ $this->_do_query( $query );
+ } else {
+ $this->insert_id = 0;
+ return false;
+ }
+ }
// If there is an error then take note of it..
- if ( $this->last_error = mysql_error( $this->dbh ) ) {
+ if ( $this->use_mysqli ) {
+ $this->last_error = mysqli_error( $this->dbh );
+ } else {
+ $this->last_error = mysql_error( $this->dbh );
+ }
+
+ if ( $this->last_error ) {
+ // Clear insert_id on a subsequent failed insert.
+ if ( $this->insert_id && preg_match( '/^\s*(insert|replace)\s/i', $query ) )
+ $this->insert_id = 0;
+
$this->print_error();
return false;
}
- if ( preg_match( "/^\\s*(insert|delete|update|replace|alter) /i", $query ) ) {
- $this->rows_affected = mysql_affected_rows( $this->dbh );
+ if ( preg_match( '/^\s*(create|alter|truncate|drop)\s/i', $query ) ) {
+ $return_val = $this->result;
+ } elseif ( preg_match( '/^\s*(insert|delete|update|replace)\s/i', $query ) ) {
+ 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
- if ( preg_match( "/^\\s*(insert|replace) /i", $query ) ) {
- $this->insert_id = mysql_insert_id($this->dbh);
+ 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_val = $this->rows_affected;
} else {
- $i = 0;
- while ( $i < @mysql_num_fields( $this->result ) ) {
- $this->col_info[$i] = @mysql_fetch_field( $this->result );
- $i++;
- }
$num_rows = 0;
- while ( $row = @mysql_fetch_object( $this->result ) ) {
- $this->last_result[$num_rows] = $row;
- $num_rows++;
+ if ( $this->use_mysqli ) {
+ while ( $row = @mysqli_fetch_object( $this->result ) ) {
+ $this->last_result[$num_rows] = $row;
+ $num_rows++;
+ }
+ } else {
+ while ( $row = @mysql_fetch_object( $this->result ) ) {
+ $this->last_result[$num_rows] = $row;
+ $num_rows++;
+ }
}
- @mysql_free_result( $this->result );
-
// Log number of rows the query returned
// and return number of rows selected
$this->num_rows = $num_rows;
return $return_val;
}
+ /**
+ * Internal function to perform the mysql_query() call.
+ *
+ * @since 3.9.0
+ *
+ * @access private
+ * @see wpdb::query()
+ *
+ * @param string $query The query to run.
+ */
+ private function _do_query( $query ) {
+ if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) {
+ $this->timer_start();
+ }
+
+ if ( $this->use_mysqli ) {
+ $this->result = @mysqli_query( $this->dbh, $query );
+ } else {
+ $this->result = @mysql_query( $query, $this->dbh );
+ }
+ $this->num_queries++;
+
+ if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) {
+ $this->queries[] = array( $query, $this->timer_stop(), $this->get_caller() );
+ }
+ }
+
/**
* Insert a row into a table.
*
* @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).
* @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', '%s' (decimal number, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+ * 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.
* @return int|false The number of rows inserted, or false on error.
*/
- function insert( $table, $data, $format = null ) {
+ public function insert( $table, $data, $format = null ) {
return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' );
}
* @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).
* @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', '%s' (decimal number, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+ * 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.
* @return int|false The number of rows affected, or false on error.
*/
- function replace( $table, $data, $format = null ) {
+ public function replace( $table, $data, $format = null ) {
return $this->_insert_replace_helper( $table, $data, $format, 'REPLACE' );
}
* @see wp_set_wpdb_vars()
*
* @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).
+ * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
* @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', '%s' (decimal number, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+ * 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.
+ * @param string $type Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT.
* @return int|false The number of rows affected, or false on error.
*/
function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {
if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ) ) )
return false;
+ $this->insert_id = 0;
$formats = $format = (array) $format;
$fields = array_keys( $data );
$formatted_fields = array();
$form = '%s';
$formatted_fields[] = $form;
}
- $sql = "{$type} INTO `$table` (`" . implode( '`,`', $fields ) . "`) VALUES ('" . implode( "','", $formatted_fields ) . "')";
+ $sql = "{$type} INTO `$table` (`" . implode( '`,`', $fields ) . "`) VALUES (" . implode( ",", $formatted_fields ) . ")";
return $this->query( $this->prepare( $sql, $data ) );
}
* @param array $data Data to update (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
* @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".
* @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', '%s' (decimal number, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
- * @param array|string $format_where 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', '%s' (decimal number, string). If omitted, all values in $where will be treated as strings.
+ * 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.
+ * @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.
*/
- function update( $table, $data, $where, $format = null, $where_format = null ) {
+ public function update( $table, $data, $where, $format = null, $where_format = null ) {
if ( ! is_array( $data ) || ! is_array( $where ) )
return false;
return $this->query( $this->prepare( $sql, array_merge( array_values( $data ), array_values( $where ) ) ) );
}
+ /**
+ * Delete a row in the table
+ *
+ * <code>
+ * wpdb::delete( 'table', array( 'ID' => 1 ) )
+ * wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) )
+ * </code>
+ *
+ * @since 3.4.0
+ * @see wpdb::prepare()
+ * @see wpdb::$field_types
+ * @see wp_set_wpdb_vars()
+ *
+ * @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".
+ * @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.
+ * @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;
+
+ $wheres = array();
+
+ $where_formats = $where_format = (array) $where_format;
+
+ foreach ( array_keys( $where ) as $field ) {
+ if ( !empty( $where_format ) ) {
+ $form = ( $form = array_shift( $where_formats ) ) ? $form : $where_format[0];
+ } elseif ( isset( $this->field_types[ $field ] ) ) {
+ $form = $this->field_types[ $field ];
+ } else {
+ $form = '%s';
+ }
+
+ $wheres[] = "$field = $form";
+ }
+
+ $sql = "DELETE FROM $table WHERE " . implode( ' AND ', $wheres );
+ return $this->query( $this->prepare( $sql, $where ) );
+ }
+
+
/**
* Retrieve one variable from the database.
*
* @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.
+ * @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
*/
- function get_var( $query = null, $x = 0, $y = 0 ) {
+ public function get_var( $query = null, $x = 0, $y = 0 ) {
$this->func_call = "\$db->get_var(\"$query\", $x, $y)";
if ( $query )
$this->query( $query );
* @param string $output Optional. one of ARRAY_A | ARRAY_N | OBJECT constants. Return an associative array (column => value, ...),
* a numerically indexed array (0 => value, ...) or an object ( ->column = value ), respectively.
* @param int $y Optional. Row to return. Indexed from 0.
- * @return mixed Database query result in format specifed by $output or null on failure
+ * @return mixed Database query result in format specified by $output or null on failure
*/
- function get_row( $query = null, $output = OBJECT, $y = 0 ) {
+ public function get_row( $query = null, $output = OBJECT, $y = 0 ) {
$this->func_call = "\$db->get_row(\"$query\",$output,$y)";
if ( $query )
$this->query( $query );
return $this->last_result[$y] ? get_object_vars( $this->last_result[$y] ) : null;
} elseif ( $output == ARRAY_N ) {
return $this->last_result[$y] ? array_values( get_object_vars( $this->last_result[$y] ) ) : null;
+ } elseif ( strtoupper( $output ) === OBJECT ) {
+ // Back compat for OBJECT being previously case insensitive.
+ return $this->last_result[$y] ? $this->last_result[$y] : null;
} else {
- $this->print_error(/*WP_I18N_DB_GETROW_ERROR*/" \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N"/*/WP_I18N_DB_GETROW_ERROR*/);
+ $this->print_error( " \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N" );
}
}
* @param int $x Optional. Column to return. Indexed from 0.
* @return array Database query result. Array indexed from 0 by SQL result row number.
*/
- function get_col( $query = null , $x = 0 ) {
+ public function get_col( $query = null , $x = 0 ) {
if ( $query )
$this->query( $query );
* @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.
* Each row is an associative array (column => value, ...), a numerically indexed array (0 => value, ...), or an object. ( ->column = value ), respectively.
- * With OBJECT_K, return an associative array of row objects keyed by the value of each row's first column's value. Duplicate keys are discarded.
+ * With OBJECT_K, return an associative array of row objects keyed by the value of each row's first column's value. Duplicate keys are discarded.
* @return mixed Database query results
*/
- function get_results( $query = null, $output = OBJECT ) {
+ public function get_results( $query = null, $output = OBJECT ) {
$this->func_call = "\$db->get_results(\"$query\", $output)";
if ( $query )
// Return an array of row objects with keys from column 1
// (Duplicates are discarded)
foreach ( $this->last_result as $row ) {
- $key = array_shift( $var_by_ref = get_object_vars( $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 ( strtoupper( $output ) === OBJECT ) {
+ // Back compat for OBJECT being previously case insensitive.
+ return $this->last_result;
}
return null;
}
+ /**
+ * Load the column metadata from the last query.
+ *
+ * @since 3.5.0
+ *
+ * @access protected
+ */
+ protected function load_col_info() {
+ if ( $this->col_info )
+ return;
+
+ if ( $this->use_mysqli ) {
+ for ( $i = 0; $i < @mysqli_num_fields( $this->result ); $i++ ) {
+ $this->col_info[ $i ] = @mysqli_fetch_field( $this->result );
+ }
+ } else {
+ for ( $i = 0; $i < @mysql_num_fields( $this->result ); $i++ ) {
+ $this->col_info[ $i ] = @mysql_fetch_field( $this->result, $i );
+ }
+ }
+ }
+
/**
* Retrieve column metadata from the last query.
*
* @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
* @return mixed Column Results
*/
- function get_col_info( $info_type = 'name', $col_offset = -1 ) {
+ public function get_col_info( $info_type = 'name', $col_offset = -1 ) {
+ $this->load_col_info();
+
if ( $this->col_info ) {
if ( $col_offset == -1 ) {
$i = 0;
*
* @return true
*/
- function timer_start() {
- $mtime = explode( ' ', microtime() );
- $this->time_start = $mtime[1] + $mtime[0];
+ public function timer_start() {
+ $this->time_start = microtime( true );
return true;
}
*
* @since 1.5.0
*
- * @return int Total time spent on the query, in milliseconds
+ * @return float Total time spent on the query, in seconds
*/
- function timer_stop() {
- $mtime = explode( ' ', microtime() );
- $time_end = $mtime[1] + $mtime[0];
- $time_total = $time_end - $this->time_start;
- return $time_total;
+ public function timer_stop() {
+ return ( microtime( true ) - $this->time_start );
}
/**
* Wraps errors in a nice header and footer and dies.
*
- * Will not die if wpdb::$show_errors is true
+ * Will not die if wpdb::$show_errors is false.
*
* @since 1.5.0
*
* @param string $error_code Optional. A Computer readable string to identify the error.
* @return false|void
*/
- function bail( $message, $error_code = '500' ) {
+ public function bail( $message, $error_code = '500' ) {
if ( !$this->show_errors ) {
if ( class_exists( 'WP_Error' ) )
$this->error = new WP_Error($error_code, $message);
*
* @return WP_Error
*/
- function check_database_version() {
+ public function check_database_version() {
global $wp_version, $required_mysql_version;
// Make sure the server has the required MySQL version
if ( version_compare($this->db_version(), $required_mysql_version, '<') )
* Called when WordPress is generating the table scheme.
*
* @since 2.5.0
+ * @deprecated 3.5.0
+ * @deprecated Use wpdb::has_cap( 'collation' )
*
* @return bool True if collation is supported, false if version does not
*/
- function supports_collation() {
+ public function supports_collation() {
+ _deprecated_function( __FUNCTION__, '3.5', 'wpdb::has_cap( \'collation\' )' );
return $this->has_cap( 'collation' );
}
/**
- * Determine if a database supports a particular feature
+ * The database character collate.
+ *
+ * @since 3.5.0
+ *
+ * @return string The database character collate.
+ */
+ public function get_charset_collate() {
+ $charset_collate = '';
+
+ if ( ! empty( $this->charset ) )
+ $charset_collate = "DEFAULT CHARACTER SET $this->charset";
+ if ( ! empty( $this->collate ) )
+ $charset_collate .= " COLLATE $this->collate";
+
+ return $charset_collate;
+ }
+
+ /**
+ * Determine if a database supports a particular feature.
*
* @since 2.7.0
- * @see wpdb::db_version()
+ * @see wpdb::db_version()
*
- * @param string $db_cap the feature
+ * @param string $db_cap The feature to check for.
* @return bool
*/
- function has_cap( $db_cap ) {
+ public function has_cap( $db_cap ) {
$version = $this->db_version();
switch ( strtolower( $db_cap ) ) {
case 'collation' : // @since 2.5.0
- case 'group_concat' : // @since 2.7
- case 'subqueries' : // @since 2.7
+ case 'group_concat' : // @since 2.7.0
+ case 'subqueries' : // @since 2.7.0
return version_compare( $version, '4.1', '>=' );
case 'set_charset' :
- return version_compare($version, '5.0.7', '>=');
+ return version_compare( $version, '5.0.7', '>=' );
};
return false;
*
* @return string The name of the calling function
*/
- function get_caller() {
- $trace = array_reverse( debug_backtrace() );
- $caller = array();
-
- foreach ( $trace as $call ) {
- if ( isset( $call['class'] ) && __CLASS__ == $call['class'] )
- continue; // Filter out wpdb calls.
- $caller[] = isset( $call['class'] ) ? "{$call['class']}->{$call['function']}" : $call['function'];
- }
-
- return join( ', ', $caller );
+ public function get_caller() {
+ return wp_debug_backtrace_summary( __CLASS__ );
}
/**
*
* @return false|string false on failure, version number on success
*/
- function db_version() {
- return preg_replace( '/[^0-9.].*/', '', mysql_get_server_info( $this->dbh ) );
+ public function db_version() {
+ 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 );
}
}
-
-?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff