2003-05-28 04:41:04 -04:00
< ? php
2008-06-22 16:23:23 -04:00
/**
* WordPress DB Class
*
* Original code from { @ link http :// php . justinvincent . com Justin Vincent ( justin @ visunet . ie )}
*
* @ package WordPress
* @ subpackage Database
* @ since 0.71
*/
/**
* @ since 0.71
*/
2010-02-22 17:53:54 -05:00
define ( 'EZSQL_VERSION' , 'WP1.25' );
2008-06-22 16:23:23 -04:00
/**
* @ since 0.71
*/
2010-02-22 17:53:54 -05:00
define ( 'OBJECT' , 'OBJECT' , true );
2008-06-22 16:23:23 -04:00
/**
2010-02-26 01:14:26 -05:00
* @ since 2.5 . 0
2008-06-22 16:23:23 -04:00
*/
2010-04-10 08:39:25 -04:00
define ( 'OBJECT_K' , 'OBJECT_K' );
2008-06-22 16:23:23 -04:00
/**
* @ since 0.71
*/
2010-04-10 08:39:25 -04:00
define ( 'ARRAY_A' , 'ARRAY_A' );
2008-06-22 16:23:23 -04:00
/**
* @ since 0.71
*/
2010-04-10 08:39:25 -04:00
define ( 'ARRAY_N' , 'ARRAY_N' );
2004-08-20 13:52:49 -04:00
2008-06-22 16:23:23 -04:00
/**
* WordPress Database Access Abstraction Object
*
* It is possible to replace this class with your own
2008-10-02 12:45:28 -04:00
* by setting the $wpdb global variable in wp - content / db . php
2011-05-23 19:37:16 -04:00
* file to your class . The wpdb class will still be included ,
* so you can extend it or simply use your own .
2008-06-22 16:23:23 -04:00
*
* @ link http :// codex . wordpress . org / Function_Reference / wpdb_Class
*
* @ package WordPress
* @ subpackage Database
* @ since 0.71
*/
2004-04-25 22:28:06 -04:00
class wpdb {
2008-06-22 16:23:23 -04:00
/**
* Whether to show SQL / DB errors
*
* @ since 0.71
* @ access private
* @ var bool
*/
2007-12-16 16:38:24 -05:00
var $show_errors = false ;
2008-06-22 16:23:23 -04:00
/**
* Whether to suppress errors during the DB bootstrapping .
*
* @ access private
2010-12-20 07:49:18 -05:00
* @ since 2.5 . 0
2008-06-22 16:23:23 -04:00
* @ var bool
*/
2008-03-12 18:41:43 -04:00
var $suppress_errors = false ;
2008-06-22 16:23:23 -04:00
/**
* The last error during query .
*
2010-12-20 07:49:18 -05:00
* @ since 2.5 . 0
2008-06-22 16:23:23 -04:00
* @ var string
*/
2008-03-20 19:34:32 -04:00
var $last_error = '' ;
2008-06-22 16:23:23 -04:00
/**
* Amount of queries made
*
* @ since 1.2 . 0
* @ access private
* @ var int
*/
2006-02-12 02:53:23 -05:00
var $num_queries = 0 ;
2008-06-22 16:23:23 -04:00
2010-02-22 17:53:54 -05:00
/**
* Count of rows returned by previous query
*
2010-12-20 07:49:18 -05:00
* @ since 1.2 . 0
2010-02-23 17:04:29 -05:00
* @ access private
2010-02-22 17:53:54 -05:00
* @ var int
*/
2010-02-23 04:06:50 -05:00
var $num_rows = 0 ;
2010-02-22 17:53:54 -05:00
/**
* Count of affected rows by previous query
*
* @ since 0.71
2010-02-23 17:04:29 -05:00
* @ access private
2010-02-22 17:53:54 -05:00
* @ var int
*/
var $rows_affected = 0 ;
2010-05-19 12:07:42 -04:00
/**
* The ID generated for an AUTO_INCREMENT column by the previous query ( usually INSERT ) .
*
* @ since 0.71
* @ access public
* @ var int
*/
var $insert_id = 0 ;
2008-06-22 16:23:23 -04:00
/**
* Saved result of the last query made
*
* @ since 1.2 . 0
* @ access private
* @ var array
*/
2004-04-25 22:54:06 -04:00
var $last_query ;
2008-06-22 16:23:23 -04:00
2010-02-22 17:53:54 -05:00
/**
2010-11-12 17:44:16 -05:00
* Results of the last query made
2010-02-22 17:53:54 -05:00
*
2010-11-12 17:44:16 -05:00
* @ since 1.0 . 0
2010-02-23 17:04:29 -05:00
* @ access private
2010-11-12 17:44:16 -05:00
* @ var array | null
2010-02-22 17:53:54 -05:00
*/
2010-11-12 17:44:16 -05:00
var $last_result ;
2010-02-22 17:53:54 -05:00
2008-06-22 16:23:23 -04:00
/**
* Saved info on the table column
*
* @ since 1.2 . 0
* @ access private
* @ var array
*/
2004-04-25 22:54:06 -04:00
var $col_info ;
2008-06-22 16:23:23 -04:00
/**
* Saved queries that were executed
*
* @ since 1.5 . 0
* @ access private
* @ var array
*/
2004-08-20 13:52:49 -04:00
var $queries ;
2008-06-22 16:23:23 -04:00
/**
* WordPress table prefix
*
* You can set this to have multiple WordPress installations
* in a single database . The second reason is for possible
* security precautions .
*
* @ since 0.71
* @ access private
* @ var string
*/
2007-10-30 23:59:18 -04:00
var $prefix = '' ;
2008-06-22 16:23:23 -04:00
/**
* Whether the database queries are ready to start executing .
*
* @ since 2.5 . 0
* @ access private
* @ var bool
*/
2007-12-21 14:30:08 -05:00
var $ready = false ;
2010-02-22 17:53:54 -05:00
/**
* { @ internal Missing Description }}
*
* @ since 3.0 . 0
2010-02-23 17:04:29 -05:00
* @ access public
2010-02-22 17:53:54 -05:00
* @ var int
*/
2010-01-08 14:26:00 -05:00
var $blogid = 0 ;
2010-02-22 17:53:54 -05:00
/**
* { @ internal Missing Description }}
*
* @ since 3.0 . 0
2010-02-23 17:04:29 -05:00
* @ access public
2010-02-22 17:53:54 -05:00
* @ var int
*/
2010-01-08 14:26:00 -05:00
var $siteid = 0 ;
2003-05-28 04:41:04 -04:00
2008-06-22 16:23:23 -04:00
/**
2010-02-23 17:04:29 -05:00
* List of WordPress per - blog tables
2008-06-22 16:23:23 -04:00
*
2010-02-26 01:14:26 -05:00
* @ since 2.5 . 0
2010-02-23 17:04:29 -05:00
* @ access private
* @ see wpdb :: tables ()
* @ var array
2008-06-22 16:23:23 -04:00
*/
2010-02-23 17:04:29 -05:00
var $tables = array ( 'posts' , 'comments' , 'links' , 'options' , 'postmeta' ,
'terms' , 'term_taxonomy' , 'term_relationships' , 'commentmeta' );
2008-06-22 16:23:23 -04:00
/**
2010-02-23 17:04:29 -05:00
* List of deprecated WordPress tables
2008-06-22 16:23:23 -04:00
*
2010-02-23 17:04:29 -05:00
* categories , post2cat , and link2cat were deprecated in 2.3 . 0 , db version 5539
*
* @ since 2.9 . 0
* @ access private
* @ see wpdb :: tables ()
* @ var array
2008-06-22 16:23:23 -04:00
*/
2010-02-23 17:04:29 -05:00
var $old_tables = array ( 'categories' , 'post2cat' , 'link2cat' );
/**
* List of WordPress global tables
*
* @ since 3.0 . 0
* @ access private
* @ see wpdb :: tables ()
* @ var array
*/
var $global_tables = array ( 'users' , 'usermeta' );
/**
* List of Multisite global tables
*
* @ since 3.0 . 0
* @ access private
* @ see wpdb :: tables ()
* @ var array
*/
var $ms_global_tables = array ( 'blogs' , 'signups' , 'site' , 'sitemeta' ,
'sitecategories' , 'registration_log' , 'blog_versions' );
2008-06-22 16:23:23 -04:00
/**
* WordPress Comments table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 04:22:18 -04:00
var $comments ;
2008-06-22 16:23:23 -04:00
2010-02-23 17:04:29 -05:00
/**
* WordPress Comment Metadata table
*
* @ since 2.9 . 0
* @ access public
* @ var string
*/
var $commentmeta ;
2008-06-22 16:23:23 -04:00
/**
* WordPress Links table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 04:22:18 -04:00
var $links ;
2008-06-22 16:23:23 -04:00
/**
* WordPress Options table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 04:22:18 -04:00
var $options ;
2008-06-22 16:23:23 -04:00
/**
* WordPress Post Metadata table
*
2010-02-26 01:14:26 -05:00
* @ since 1.5 . 0
2008-06-22 16:23:23 -04:00
* @ access public
* @ var string
*/
2004-05-24 04:22:18 -04:00
var $postmeta ;
2008-06-22 16:23:23 -04:00
2009-09-17 16:17:33 -04:00
/**
2010-02-23 17:04:29 -05:00
* WordPress Posts table
2009-09-17 16:17:33 -04:00
*
2010-02-23 17:04:29 -05:00
* @ since 1.5 . 0
2009-09-17 16:17:33 -04:00
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $posts ;
2009-09-17 16:17:33 -04:00
2008-06-22 16:23:23 -04:00
/**
2010-02-23 17:04:29 -05:00
* WordPress Terms table
2008-06-22 16:23:23 -04:00
*
* @ since 2.3 . 0
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $terms ;
2008-06-22 16:23:23 -04:00
/**
2010-02-23 17:04:29 -05:00
* WordPress Term Relationships table
2008-06-22 16:23:23 -04:00
*
* @ since 2.3 . 0
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $term_relationships ;
2008-06-22 16:23:23 -04:00
/**
* WordPress Term Taxonomy table
*
* @ since 2.3 . 0
* @ access public
* @ var string
*/
2007-05-22 01:12:38 -04:00
var $term_taxonomy ;
2008-06-22 16:23:23 -04:00
2010-02-23 17:04:29 -05:00
/*
* Global and Multisite tables
*/
2008-06-22 16:23:23 -04:00
/**
2010-02-23 17:04:29 -05:00
* WordPress User Metadata table
2008-06-22 16:23:23 -04:00
*
* @ since 2.3 . 0
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $usermeta ;
2008-06-22 16:23:23 -04:00
2009-09-06 14:46:27 -04:00
/**
2010-02-23 17:04:29 -05:00
* WordPress Users table
2009-09-06 14:46:27 -04:00
*
2010-02-23 17:04:29 -05:00
* @ since 1.5 . 0
* @ access public
* @ var string
2009-09-06 14:46:27 -04:00
*/
2010-02-23 17:04:29 -05:00
var $users ;
2009-09-06 14:46:27 -04:00
2010-02-19 14:57:03 -05:00
/**
* Multisite Blogs table
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
var $blogs ;
/**
2010-02-23 17:04:29 -05:00
* Multisite Blog Versions table
2010-02-19 14:57:03 -05:00
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $blog_versions ;
2010-02-19 14:57:03 -05:00
/**
2010-02-23 17:04:29 -05:00
* Multisite Registration Log table
2010-02-19 14:57:03 -05:00
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $registration_log ;
2009-09-14 10:03:32 -04:00
2009-04-10 17:56:30 -04:00
/**
2010-02-23 17:04:29 -05:00
* Multisite Signups table
2010-02-19 14:57:03 -05:00
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $signups ;
2010-02-19 14:57:03 -05:00
/**
2010-02-23 17:04:29 -05:00
* Multisite Sites table
2010-02-19 14:57:03 -05:00
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $site ;
2010-02-19 14:57:03 -05:00
/**
2010-02-23 17:04:29 -05:00
* Multisite Sitewide Terms table
2010-02-19 14:57:03 -05:00
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $sitecategories ;
2010-02-19 14:57:03 -05:00
/**
2010-02-23 17:04:29 -05:00
* Multisite Site Metadata table
2010-02-19 14:57:03 -05:00
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
2010-02-23 17:04:29 -05:00
var $sitemeta ;
2010-02-19 14:57:03 -05:00
/**
2010-02-22 17:53:54 -05:00
* Format specifiers for DB columns . Columns not listed here default to % s . Initialized during WP load .
2010-02-23 04:06:50 -05:00
*
2010-02-22 17:53:54 -05:00
* Keys are column names , values are format types : 'ID' => '%d'
2009-04-10 17:56:30 -04:00
*
* @ since 2.8 . 0
2012-03-24 11:24:31 -04:00
* @ see wpdb :: prepare ()
* @ see wpdb :: insert ()
* @ see wpdb :: update ()
* @ see wpdb :: delete ()
2010-02-19 14:57:03 -05:00
* @ see wp_set_wpdb_vars ()
2009-04-10 17:56:30 -04:00
* @ access public
2010-01-19 12:28:48 -05:00
* @ var array
2009-04-10 17:56:30 -04:00
*/
2009-04-14 18:34:51 -04:00
var $field_types = array ();
2009-04-10 17:56:30 -04:00
2008-06-22 16:23:23 -04:00
/**
* Database table columns charset
*
* @ since 2.2 . 0
* @ access public
* @ var string
*/
2007-02-01 19:04:35 -05:00
var $charset ;
2008-06-22 16:23:23 -04:00
/**
* Database table columns collate
*
* @ since 2.2 . 0
* @ access public
* @ var string
*/
2007-02-01 19:04:35 -05:00
var $collate ;
2009-02-19 14:01:57 -05:00
/**
* Whether to use mysql_real_escape_string
*
* @ since 2.8 . 0
* @ access public
* @ var bool
*/
var $real_escape = false ;
2009-08-21 13:00:53 -04:00
/**
* Database Username
*
* @ since 2.9 . 0
* @ access private
* @ var string
*/
var $dbuser ;
2010-03-11 16:30:29 -05:00
/**
* A textual description of the last query / get_row / get_var call
*
2010-12-01 14:24:38 -05:00
* @ since 3.0 . 0
2010-03-11 16:30:29 -05:00
* @ access public
* @ var string
*/
var $func_call ;
2011-10-25 01:29:28 -04:00
/**
* Whether MySQL is used as the database engine .
*
* 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
* @ access public
* @ var bool
*/
public $is_mysql = null ;
2008-06-22 16:23:23 -04:00
/**
* Connects to the database server and selects a database
*
* PHP5 style constructor for compatibility with PHP5 . Does
* the actual setting up of the class properties and connection
* to the database .
*
2010-02-26 01:14:26 -05:00
* @ link http :// core . trac . wordpress . org / ticket / 3354
2008-06-22 16:23:23 -04:00
* @ since 2.0 . 8
*
* @ param string $dbuser MySQL database user
* @ param string $dbpassword MySQL database password
* @ param string $dbname MySQL database name
* @ param string $dbhost MySQL database host
*/
2010-02-22 17:53:54 -05:00
function __construct ( $dbuser , $dbpassword , $dbname , $dbhost ) {
register_shutdown_function ( array ( & $this , '__destruct' ) );
2007-01-06 18:36:51 -05:00
2010-02-18 20:03:58 -05:00
if ( WP_DEBUG )
2007-12-22 12:45:30 -05:00
$this -> show_errors ();
2010-08-26 14:34:18 -04:00
$this -> init_charset ();
$this -> dbuser = $dbuser ;
$this -> dbpassword = $dbpassword ;
$this -> dbname = $dbname ;
$this -> dbhost = $dbhost ;
$this -> db_connect ();
}
/**
* PHP5 style destructor and will run when database object is destroyed .
*
* @ see wpdb :: __construct ()
* @ since 2.0 . 8
* @ return bool true
*/
function __destruct () {
return true ;
}
/**
* Set $this -> charset and $this -> collate
2010-12-20 07:49:18 -05:00
*
* @ since 3.1 . 0
2010-08-26 14:34:18 -04:00
*/
function init_charset () {
if ( function_exists ( 'is_multisite' ) && is_multisite () ) {
2010-01-18 17:21:36 -05:00
$this -> charset = 'utf8' ;
2010-02-18 20:03:58 -05:00
if ( defined ( 'DB_COLLATE' ) && DB_COLLATE )
$this -> collate = DB_COLLATE ;
2010-01-18 17:21:36 -05:00
else
$this -> collate = 'utf8_general_ci' ;
2010-02-18 20:03:58 -05:00
} elseif ( defined ( 'DB_COLLATE' ) ) {
$this -> collate = DB_COLLATE ;
2010-01-18 17:21:36 -05:00
}
2010-01-08 14:26:00 -05:00
2010-02-22 17:53:54 -05:00
if ( defined ( 'DB_CHARSET' ) )
2007-02-01 19:04:35 -05:00
$this -> charset = DB_CHARSET ;
2010-08-26 14:34:18 -04:00
}
2007-02-01 19:04:35 -05:00
2010-08-26 14:34:18 -04:00
/**
* Sets the connection ' s character set .
2010-10-19 03:48:22 -04:00
*
2010-12-20 07:49:18 -05:00
* @ since 3.1 . 0
*
2010-08-26 14:34:18 -04:00
* @ param resource $dbh The resource given by mysql_connect
* @ param string $charset The character set ( optional )
* @ param string $collate The collation ( optional )
*/
function set_charset ( $dbh , $charset = null , $collate = null ) {
if ( ! isset ( $charset ) )
$charset = $this -> charset ;
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 );
2009-12-15 16:01:57 -05:00
$this -> real_escape = true ;
} else {
2010-08-26 14:34:18 -04:00
$query = $this -> prepare ( 'SET NAMES %s' , $charset );
if ( ! empty ( $collate ) )
$query .= $this -> prepare ( ' COLLATE %s' , $collate );
mysql_query ( $query , $dbh );
2008-03-30 13:56:27 -04:00
}
}
2007-01-06 18:36:51 -05:00
}
2008-06-22 16:23:23 -04:00
/**
* Sets the table prefix for the WordPress tables .
*
* @ since 2.5 . 0
*
* @ param string $prefix Alphanumeric name for the new prefix .
2011-09-22 08:02:31 -04:00
* @ param bool $set_table_names Optional . Whether the table names , e . g . wpdb :: $posts , should be updated or not .
2009-04-10 17:57:40 -04:00
* @ return string | WP_Error Old prefix or WP_Error on error
2008-06-22 16:23:23 -04:00
*/
2010-02-24 16:30:13 -05:00
function set_prefix ( $prefix , $set_table_names = true ) {
2007-10-30 23:59:18 -04:00
2010-02-22 17:53:54 -05:00
if ( preg_match ( '|[^a-z0-9_]|i' , $prefix ) )
2012-01-26 15:34:27 -05:00
return new WP_Error ( 'invalid_db_prefix' , 'Invalid database prefix' );
2007-10-30 23:59:18 -04:00
2010-02-22 17:53:54 -05:00
$old_prefix = is_multisite () ? '' : $prefix ;
2010-01-18 17:21:36 -05:00
if ( isset ( $this -> base_prefix ) )
2010-01-08 14:26:00 -05:00
$old_prefix = $this -> base_prefix ;
2010-02-23 17:04:29 -05:00
2010-01-08 14:26:00 -05:00
$this -> base_prefix = $prefix ;
2010-02-23 17:04:29 -05:00
2010-02-24 16:30:13 -05:00
if ( $set_table_names ) {
foreach ( $this -> tables ( 'global' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
2010-01-08 14:26:00 -05:00
2010-05-04 16:48:28 -04:00
if ( is_multisite () && empty ( $this -> blogid ) )
2010-02-24 16:30:13 -05:00
return $old_prefix ;
2007-10-30 23:59:18 -04:00
2010-04-10 08:39:25 -04:00
$this -> prefix = $this -> get_blog_prefix ();
2010-02-19 14:57:03 -05:00
2010-02-24 16:30:13 -05:00
foreach ( $this -> tables ( 'blog' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
2007-10-30 23:59:18 -04:00
2010-02-24 16:30:13 -05:00
foreach ( $this -> tables ( 'old' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
}
2007-10-30 23:59:18 -04:00
return $old_prefix ;
}
2010-02-22 17:53:54 -05:00
/**
* Sets blog id .
*
* @ since 3.0 . 0
* @ access public
2010-02-23 17:04:29 -05:00
* @ param int $blog_id
* @ param int $site_id Optional .
2010-02-22 17:53:54 -05:00
* @ return string previous blog id
2010-02-23 04:06:50 -05:00
*/
2010-02-23 17:04:29 -05:00
function set_blog_id ( $blog_id , $site_id = 0 ) {
2010-02-22 17:53:54 -05:00
if ( ! empty ( $site_id ) )
2010-01-08 14:26:00 -05:00
$this -> siteid = $site_id ;
2010-02-22 17:53:54 -05:00
$old_blog_id = $this -> blogid ;
2010-01-08 14:26:00 -05:00
$this -> blogid = $blog_id ;
2010-04-10 08:39:25 -04:00
$this -> prefix = $this -> get_blog_prefix ();
2010-01-08 14:26:00 -05:00
2010-02-23 04:06:50 -05:00
foreach ( $this -> tables ( 'blog' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
2010-02-19 14:57:03 -05:00
2010-02-23 04:06:50 -05:00
foreach ( $this -> tables ( 'old' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
2010-01-08 14:26:00 -05:00
return $old_blog_id ;
}
2010-02-22 17:53:54 -05:00
/**
* Gets blog prefix .
*
* @ uses is_multisite ()
* @ since 3.0 . 0
2010-02-23 17:04:29 -05:00
* @ param int $blog_id Optional .
2010-02-22 17:53:54 -05:00
* @ return string Blog prefix .
*/
2010-04-10 08:39:25 -04:00
function get_blog_prefix ( $blog_id = null ) {
2010-04-02 18:47:51 -04:00
if ( is_multisite () ) {
2010-04-10 08:39:25 -04:00
if ( null === $blog_id )
2010-04-02 18:47:51 -04:00
$blog_id = $this -> blogid ;
2011-06-27 16:47:04 -04:00
$blog_id = ( int ) $blog_id ;
2010-02-23 17:04:29 -05:00
if ( defined ( 'MULTISITE' ) && ( 0 == $blog_id || 1 == $blog_id ) )
2010-02-13 14:57:43 -05:00
return $this -> base_prefix ;
else
return $this -> base_prefix . $blog_id . '_' ;
2010-01-08 14:26:00 -05:00
} else {
return $this -> base_prefix ;
}
}
2010-02-19 14:57:03 -05:00
/**
* Returns an array of WordPress tables .
*
2010-02-23 04:06:50 -05:00
* Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
2011-09-05 15:08:15 -04:00
* override the WordPress users and usermeta tables that would otherwise
2010-02-23 04:06:50 -05:00
* be determined by the prefix .
*
2010-02-24 13:58:52 -05:00
* The scope argument can take one of the following :
*
* 'all' - returns 'all' and 'global' tables . No old tables are returned .
2010-02-26 01:14:26 -05:00
* 'blog' - returns the blog - level tables for the queried blog .
2010-02-24 13:58:52 -05:00
* 'global' - returns the global tables for the installation , returning multisite tables only if running multisite .
* 'ms_global' - returns the multisite global tables , regardless if current installation is multisite .
* 'old' - returns tables which are deprecated .
*
2010-02-19 14:57:03 -05:00
* @ since 3.0 . 0
2010-02-23 17:04:29 -05:00
* @ uses wpdb :: $tables
* @ uses wpdb :: $old_tables
* @ uses wpdb :: $global_tables
* @ uses wpdb :: $ms_global_tables
2010-02-19 14:57:03 -05:00
* @ uses is_multisite ()
*
2010-02-24 13:58:52 -05:00
* @ param string $scope Optional . Can be all , global , ms_global , blog , or old tables . Defaults to all .
* @ param bool $prefix Optional . Whether to include table prefixes . Default true . If blog
2010-02-23 17:04:29 -05:00
* prefix is requested , then the custom users and usermeta tables will be mapped .
2010-02-26 01:14:26 -05:00
* @ param int $blog_id Optional . The blog_id to prefix . Defaults to wpdb :: $blogid . Used only when prefix is requested .
2010-02-23 14:58:53 -05:00
* @ return array Table names . When a prefix is requested , the key is the unprefixed table name .
2010-02-23 04:06:50 -05:00
*/
function tables ( $scope = 'all' , $prefix = true , $blog_id = 0 ) {
2010-02-19 14:57:03 -05:00
switch ( $scope ) {
2010-02-24 13:58:52 -05:00
case 'all' :
$tables = array_merge ( $this -> global_tables , $this -> tables );
if ( is_multisite () )
$tables = array_merge ( $tables , $this -> ms_global_tables );
2010-02-23 14:58:53 -05:00
break ;
2010-02-26 01:14:26 -05:00
case 'blog' :
$tables = $this -> tables ;
break ;
2010-02-19 14:57:03 -05:00
case 'global' :
2010-02-23 04:06:50 -05:00
$tables = $this -> global_tables ;
if ( is_multisite () )
$tables = array_merge ( $tables , $this -> ms_global_tables );
2010-02-19 14:57:03 -05:00
break ;
2010-02-24 13:58:52 -05:00
case 'ms_global' :
$tables = $this -> ms_global_tables ;
break ;
case 'old' :
$tables = $this -> old_tables ;
break ;
default :
return array ();
2010-02-19 14:57:03 -05:00
break ;
}
if ( $prefix ) {
2010-02-23 15:38:41 -05:00
if ( ! $blog_id )
$blog_id = $this -> blogid ;
2010-02-23 17:04:29 -05:00
$blog_prefix = $this -> get_blog_prefix ( $blog_id );
2010-02-23 04:06:50 -05:00
$base_prefix = $this -> base_prefix ;
$global_tables = array_merge ( $this -> global_tables , $this -> ms_global_tables );
2010-02-20 05:50:57 -05:00
foreach ( $tables as $k => $table ) {
2010-02-23 04:06:50 -05:00
if ( in_array ( $table , $global_tables ) )
$tables [ $table ] = $base_prefix . $table ;
else
2010-02-23 17:04:29 -05:00
$tables [ $table ] = $blog_prefix . $table ;
2010-02-23 04:06:50 -05:00
unset ( $tables [ $k ] );
2010-02-19 14:57:03 -05:00
}
2010-02-23 04:06:50 -05:00
if ( isset ( $tables [ 'users' ] ) && defined ( 'CUSTOM_USER_TABLE' ) )
$tables [ 'users' ] = CUSTOM_USER_TABLE ;
if ( isset ( $tables [ 'usermeta' ] ) && defined ( 'CUSTOM_USER_META_TABLE' ) )
$tables [ 'usermeta' ] = CUSTOM_USER_META_TABLE ;
2010-02-19 14:57:03 -05:00
}
return $tables ;
}
2006-11-29 20:44:33 -05:00
/**
2008-06-22 16:23:23 -04:00
* Selects a database using the current database connection .
*
* The database name will be changed based on the current database
* connection . On failure , the execution will bail and display an DB error .
*
* @ since 0.71
*
* @ param string $db MySQL database name
2010-06-16 15:28:01 -04:00
* @ param resource $dbh Optional link identifier .
2008-06-22 16:23:23 -04:00
* @ return null Always null .
2006-11-29 20:44:33 -05:00
*/
2011-09-22 08:02:31 -04:00
function select ( $db , $dbh = null ) {
2010-10-19 03:48:22 -04:00
if ( is_null ( $dbh ) )
2010-06-16 15:28:01 -04:00
$dbh = $this -> dbh ;
2010-02-22 17:53:54 -05:00
if ( !@ mysql_select_db ( $db , $dbh ) ) {
2007-12-22 01:24:48 -05:00
$this -> ready = false ;
2012-01-26 15:34:27 -05:00
wp_load_translations_early ();
$this -> bail ( sprintf ( __ ( ' < h1 > Can & #8217;t select database</h1>
2008-06-23 11:40:43 -04:00
< 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 >
2004-07-22 21:35:56 -04:00
< ul >
< li > Are you sure it exists ? </ li >
2008-06-23 11:40:43 -04:00
< li > Does the user < code >% 2 $s </ code > have permission to use the < code >% 1 $s </ code > database ? </ li >
2008-11-27 23:40:20 -05:00
< 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 >
2004-07-22 21:35:56 -04:00
</ ul >
2012-04-16 17:55:47 -04:00
< 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>' ), htmlspecialchars ( $db , ENT_QUOTES ), htmlspecialchars ( $this -> dbuser , ENT_QUOTES ) ), 'db_select_fail' );
2007-12-21 14:30:08 -05:00
return ;
2003-05-28 04:41:04 -04:00
}
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2010-02-22 17:53:54 -05:00
/**
2010-02-24 13:58:52 -05:00
* Weak escape , using addslashes ()
2010-02-22 17:53:54 -05:00
*
2010-02-24 13:58:52 -05:00
* @ see addslashes ()
2010-02-26 01:14:26 -05:00
* @ since 2.8 . 0
2010-02-22 17:53:54 -05:00
* @ access private
*
2010-02-26 01:14:26 -05:00
* @ param string $string
2010-02-22 17:53:54 -05:00
* @ return string
*/
function _weak_escape ( $string ) {
return addslashes ( $string );
2009-02-20 14:05:12 -05:00
}
2010-02-22 17:53:54 -05:00
/**
2010-02-24 13:58:52 -05:00
* Real escape , using mysql_real_escape_string () or addslashes ()
2010-02-22 17:53:54 -05:00
*
2010-02-24 13:58:52 -05:00
* @ see mysql_real_escape_string ()
* @ see addslashes ()
2010-12-20 07:49:18 -05:00
* @ since 2.8 . 0
2010-02-22 17:53:54 -05:00
* @ access private
*
* @ param string $string to escape
* @ return string escaped
*/
function _real_escape ( $string ) {
2009-02-20 14:05:12 -05:00
if ( $this -> dbh && $this -> real_escape )
return mysql_real_escape_string ( $string , $this -> dbh );
else
2009-03-17 22:43:45 -04:00
return addslashes ( $string );
2009-02-20 14:05:12 -05:00
}
2010-02-22 17:53:54 -05:00
/**
2010-02-23 17:04:29 -05:00
* Escape data . Works on arrays .
2010-02-22 17:53:54 -05:00
*
2010-06-29 20:05:18 -04:00
* @ uses wpdb :: _escape ()
* @ uses wpdb :: _real_escape ()
2010-12-20 07:49:18 -05:00
* @ since 2.8 . 0
2010-02-22 17:53:54 -05:00
* @ access private
*
* @ param string | array $data
* @ return string | array escaped
*/
function _escape ( $data ) {
if ( is_array ( $data ) ) {
2009-02-20 14:05:12 -05:00
foreach ( ( array ) $data as $k => $v ) {
if ( is_array ( $v ) )
$data [ $k ] = $this -> _escape ( $v );
else
$data [ $k ] = $this -> _real_escape ( $v );
}
} else {
$data = $this -> _real_escape ( $data );
}
return $data ;
}
2006-11-29 20:44:33 -05:00
/**
2010-02-23 17:04:29 -05:00
* Escapes content for insertion into the database using addslashes (), for security .
2006-11-29 20:44:33 -05:00
*
2010-02-23 17:04:29 -05:00
* Works on arrays .
2008-06-22 16:23:23 -04:00
*
2010-02-23 17:04:29 -05:00
* @ since 0.71
2010-02-24 13:58:52 -05:00
* @ param string | array $data to escape
2010-02-22 17:53:54 -05:00
* @ return string | array escaped as query safe string
2006-11-29 20:44:33 -05:00
*/
2010-02-22 17:53:54 -05:00
function escape ( $data ) {
if ( is_array ( $data ) ) {
2009-02-20 14:05:12 -05:00
foreach ( ( array ) $data as $k => $v ) {
2010-02-22 17:53:54 -05:00
if ( is_array ( $v ) )
2009-02-20 14:05:12 -05:00
$data [ $k ] = $this -> escape ( $v );
else
$data [ $k ] = $this -> _weak_escape ( $v );
}
} else {
$data = $this -> _weak_escape ( $data );
}
return $data ;
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2007-07-04 12:18:57 -04:00
/**
* Escapes content by reference for insertion into the database , for security
2008-06-22 16:23:23 -04:00
*
2010-02-23 17:04:29 -05:00
* @ uses wpdb :: _real_escape ()
2008-06-22 16:23:23 -04:00
* @ since 2.3 . 0
2010-02-24 13:58:52 -05:00
* @ param string $string to escape
2010-02-22 17:53:54 -05:00
* @ return void
2007-07-04 12:18:57 -04:00
*/
2010-02-22 17:53:54 -05:00
function escape_by_ref ( & $string ) {
2009-02-20 14:05:12 -05:00
$string = $this -> _real_escape ( $string );
2007-07-04 12:18:57 -04:00
}
/**
2010-04-10 08:39:25 -04:00
* Prepares a SQL query for safe execution . Uses sprintf () - like syntax .
2008-06-22 16:23:23 -04:00
*
2010-02-23 04:06:50 -05:00
* The following directives can be used in the query format string :
2011-08-19 11:01:35 -04:00
* % d ( integer )
2011-09-19 01:15:44 -04:00
* % f ( float )
2010-02-22 17:53:54 -05:00
* % s ( string )
2010-02-23 04:06:50 -05:00
* %% ( literal percentage sign - no argument needed )
2010-02-22 17:53:54 -05:00
*
2011-09-19 01:15:44 -04:00
* All of % d , % f , and % s are to be left unquoted in the query string and they need an argument passed for them .
2010-04-10 08:39:25 -04:00
* Literals ( % ) as parts of the query must be properly written as %%.
2010-02-22 17:53:54 -05:00
*
2011-09-19 01:15:44 -04:00
* This function only supports a small subset of the sprintf syntax ; it only supports % d ( integer ), % f ( float ), and % s ( string ) .
2009-04-10 17:57:40 -04:00
* Does not support sign , padding , alignment , width or precision specifiers .
* Does not support argument numbering / swapping .
*
* May be called like { @ link http :// php . net / sprintf sprintf ()} or like { @ link http :// php . net / vsprintf vsprintf ()} .
*
* Both % d and % s should be left unquoted in the query string .
*
* < code >
2010-02-23 17:04:29 -05:00
* wpdb :: prepare ( " SELECT * FROM `table` WHERE `column` = %s AND `field` = %d " , 'foo' , 1337 )
* wpdb :: prepare ( " SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s " , 'foo' );
2009-04-10 17:57:40 -04:00
* </ code >
*
* @ link http :// php . net / sprintf Description of syntax .
2008-06-22 16:23:23 -04:00
* @ since 2.3 . 0
*
2009-04-10 17:57:40 -04:00
* @ param string $query Query statement with sprintf () - like placeholders
2010-02-22 17:53:54 -05:00
* @ param array | mixed $args The array of variables to substitute into the query ' s placeholders if being called like
* { @ link http :// php . net / vsprintf vsprintf ()}, or the first variable to substitute into the query ' s placeholders if
* being called like { @ link http :// php . net / sprintf sprintf ()} .
* @ param mixed $args , ... further variables to substitute into the query ' s placeholders if being called like
* { @ link http :// php . net / sprintf sprintf ()} .
* @ 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 )
2009-04-10 17:57:40 -04:00
if ( is_null ( $query ) )
2007-07-04 12:18:57 -04:00
return ;
2010-02-23 17:04:29 -05:00
2007-07-04 12:18:57 -04:00
$args = func_get_args ();
2010-02-22 17:53:54 -05:00
array_shift ( $args );
2009-04-10 17:57:40 -04:00
// If args were passed as an array (as in vsprintf), move them up
2010-02-22 17:53:54 -05:00
if ( isset ( $args [ 0 ] ) && is_array ( $args [ 0 ]) )
2009-03-05 17:15:17 -05:00
$args = $args [ 0 ];
2010-02-22 17:53:54 -05:00
$query = str_replace ( " '%s' " , '%s' , $query ); // in case someone mistakenly already singlequoted it
$query = str_replace ( '"%s"' , '%s' , $query ); // doublequote unquoting
2010-02-26 01:14:26 -05:00
$query = preg_replace ( '|(?<!%)%s|' , " '%s' " , $query ); // quote the strings, avoiding escaped strings like %%s
2010-02-22 17:53:54 -05:00
array_walk ( $args , array ( & $this , 'escape_by_ref' ) );
return @ vsprintf ( $query , $args );
2007-07-04 12:18:57 -04:00
}
2008-06-22 16:23:23 -04:00
/**
* Print SQL / DB error .
*
* @ since 0.71
* @ global array $EZSQL_ERROR Stores error information of query and error string
*
* @ param string $str The error to display
* @ return bool False if the showing of errors is disabled .
*/
2010-02-22 17:53:54 -05:00
function print_error ( $str = '' ) {
2004-04-25 22:28:06 -04:00
global $EZSQL_ERROR ;
2008-03-12 18:41:43 -04:00
2010-02-22 17:53:54 -05:00
if ( ! $str )
$str = mysql_error ( $this -> dbh );
$EZSQL_ERROR [] = array ( 'query' => $this -> last_query , 'error_str' => $str );
2004-04-25 22:28:06 -04:00
2008-03-12 18:41:43 -04:00
if ( $this -> suppress_errors )
return false ;
2012-01-26 15:34:27 -05:00
wp_load_translations_early ();
2007-12-16 16:38:24 -05:00
if ( $caller = $this -> get_caller () )
2012-01-26 15:34:27 -05:00
$error_str = sprintf ( __ ( 'WordPress database error %1$s for query %2$s made by %3$s' ), $str , $this -> last_query , $caller );
2008-06-23 11:40:43 -04:00
else
2012-01-26 15:34:27 -05:00
$error_str = sprintf ( __ ( 'WordPress database error %1$s for query %2$s' ), $str , $this -> last_query );
2008-03-20 15:08:40 -04:00
2010-02-26 01:14:26 -05:00
if ( function_exists ( 'error_log' )
2010-03-03 18:07:23 -05:00
&& ( $log_file = @ ini_get ( 'error_log' ) )
2010-02-26 01:14:26 -05:00
&& ( 'syslog' == $log_file || @ is_writable ( $log_file ) )
)
@ error_log ( $error_str );
2007-12-16 16:38:24 -05:00
2010-02-26 01:14:26 -05:00
// Are we showing errors?
2010-02-23 17:04:29 -05:00
if ( ! $this -> show_errors )
2006-02-12 02:53:23 -05:00
return false ;
2007-12-16 16:38:24 -05:00
2010-01-18 17:21:36 -05:00
// If there is an error then take note of it
if ( is_multisite () ) {
$msg = " WordPress database error: [ $str ] \n { $this -> last_query } \n " ;
if ( defined ( 'ERRORLOGFILE' ) )
2010-02-18 20:03:58 -05:00
error_log ( $msg , 3 , ERRORLOGFILE );
2010-01-18 17:21:36 -05:00
if ( defined ( 'DIEONDBERROR' ) )
2010-02-23 17:04:29 -05:00
wp_die ( $msg );
2010-01-18 17:21:36 -05:00
} else {
2010-02-22 17:53:54 -05:00
$str = htmlspecialchars ( $str , ENT_QUOTES );
$query = htmlspecialchars ( $this -> last_query , ENT_QUOTES );
2010-01-18 17:21:36 -05:00
print " <div id='error'>
< p class = 'wpdberror' >< strong > WordPress database error :</ strong > [ $str ] < br />
< code > $query </ code ></ p >
</ div > " ;
}
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2008-06-22 16:23:23 -04:00
/**
* 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 ,
* this function can be used to enable and disable showing of database
* errors .
*
* @ since 0.71
2010-02-22 17:53:54 -05:00
* @ see wpdb :: hide_errors ()
2008-06-22 16:23:23 -04:00
*
* @ param bool $show Whether to show or hide errors
* @ return bool Old value for showing errors .
*/
2007-12-16 16:38:24 -05:00
function show_errors ( $show = true ) {
$errors = $this -> show_errors ;
$this -> show_errors = $show ;
return $errors ;
2004-04-25 22:28:06 -04:00
}
2006-02-12 02:53:23 -05:00
2008-06-22 16:23:23 -04:00
/**
* Disables showing of database errors .
*
2010-02-22 17:53:54 -05:00
* By default database errors are not shown .
*
2008-06-22 16:23:23 -04:00
* @ since 0.71
2010-02-22 17:53:54 -05:00
* @ see wpdb :: show_errors ()
2008-06-22 16:23:23 -04:00
*
2010-02-24 15:13:23 -05:00
* @ return bool Whether showing of errors was active
2008-06-22 16:23:23 -04:00
*/
2004-04-25 22:28:06 -04:00
function hide_errors () {
2007-12-16 16:38:24 -05:00
$show = $this -> show_errors ;
2004-04-25 22:28:06 -04:00
$this -> show_errors = false ;
2007-12-16 16:38:24 -05:00
return $show ;
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2008-06-22 16:23:23 -04:00
/**
* Whether to suppress database errors .
*
2010-02-22 17:53:54 -05:00
* By default database errors are suppressed , with a simple
* call to this function they can be enabled .
*
2010-12-20 07:49:18 -05:00
* @ since 2.5 . 0
2010-02-22 17:53:54 -05:00
* @ see wpdb :: hide_errors ()
* @ param bool $suppress Optional . New value . Defaults to true .
* @ return bool Old value
2008-06-22 16:23:23 -04:00
*/
2008-03-12 18:41:43 -04:00
function suppress_errors ( $suppress = true ) {
$errors = $this -> suppress_errors ;
2010-02-22 17:53:54 -05:00
$this -> suppress_errors = ( bool ) $suppress ;
2008-03-12 18:41:43 -04:00
return $errors ;
}
2008-06-22 16:23:23 -04:00
/**
* Kill cached query results .
*
* @ since 0.71
2010-02-22 17:53:54 -05:00
* @ return void
2008-06-22 16:23:23 -04:00
*/
2004-04-25 22:28:06 -04:00
function flush () {
2010-11-12 17:44:16 -05:00
$this -> last_result = array ();
2010-02-22 17:53:54 -05:00
$this -> col_info = null ;
$this -> last_query = null ;
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2010-08-26 14:34:18 -04:00
/**
* Connect to and select database
2010-12-20 07:49:18 -05:00
*
* @ since 3.0 . 0
2010-08-26 14:34:18 -04:00
*/
function db_connect () {
2011-10-25 01:29:28 -04:00
$this -> is_mysql = true ;
2010-10-14 14:47:39 -04:00
if ( WP_DEBUG ) {
$this -> dbh = mysql_connect ( $this -> dbhost , $this -> dbuser , $this -> dbpassword , true );
} else {
$this -> dbh = @ mysql_connect ( $this -> dbhost , $this -> dbuser , $this -> dbpassword , true );
}
2010-08-26 14:34:18 -04:00
if ( ! $this -> dbh ) {
2012-01-26 15:34:27 -05:00
wp_load_translations_early ();
$this -> bail ( sprintf ( __ ( "
2010-01-08 14:26:00 -05:00
< h1 > Error establishing a database connection </ h1 >
2010-02-23 04:44:27 -05:00
< 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 >
2010-01-08 14:26:00 -05:00
< ul >
< li > Are you sure you have the correct username and password ? </ li >
< 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 >
2012-04-16 17:55:47 -04:00
" ), htmlspecialchars( $this->dbhost , ENT_QUOTES ) ), 'db_connect_fail' );
2010-10-21 15:55:28 -04:00
2011-03-23 15:57:35 -04:00
return ;
2010-01-08 14:26:00 -05:00
}
2010-08-26 14:34:18 -04:00
$this -> set_charset ( $this -> dbh );
$this -> ready = true ;
$this -> select ( $this -> dbname , $this -> dbh );
2010-01-08 14:26:00 -05:00
}
2008-06-22 16:23:23 -04:00
/**
* Perform a MySQL database query , using current database connection .
*
* More information can be found on the codex page .
*
* @ since 0.71
*
2010-02-22 17:53:54 -05:00
* @ param string $query Database query
2009-04-10 17:57:40 -04:00
* @ return int | false Number of rows affected / selected or false on error
2008-06-22 16:23:23 -04:00
*/
2010-02-22 17:53:54 -05:00
function query ( $query ) {
2007-12-21 14:54:46 -05:00
if ( ! $this -> ready )
2007-12-21 14:30:08 -05:00
return false ;
2010-02-23 17:04:29 -05:00
// some queries are made before the plugins have been loaded, and thus cannot be filtered with this method
2012-01-26 15:34:27 -05:00
$query = apply_filters ( 'query' , $query );
2006-12-06 19:02:03 -05:00
2004-04-25 22:54:06 -04:00
$return_val = 0 ;
2004-04-25 22:28:06 -04:00
$this -> flush ();
2003-05-28 04:41:04 -04:00
2004-04-25 22:28:06 -04:00
// Log how the function was called
$this -> func_call = " \$ db->query( \" $query\ " ) " ;
// Keep track of the last query for debug..
$this -> last_query = $query ;
2010-02-22 17:53:54 -05:00
if ( defined ( 'SAVEQUERIES' ) && SAVEQUERIES )
2004-08-20 13:52:49 -04:00
$this -> timer_start ();
2010-01-15 17:11:12 -05:00
2010-11-12 17:44:16 -05:00
$this -> result = @ mysql_query ( $query , $this -> dbh );
2010-02-23 17:04:29 -05:00
$this -> num_queries ++ ;
2007-02-27 10:24:54 -05:00
2010-02-23 17:04:29 -05:00
if ( defined ( 'SAVEQUERIES' ) && SAVEQUERIES )
2007-11-20 19:14:58 -05:00
$this -> queries [] = array ( $query , $this -> timer_stop (), $this -> get_caller () );
2004-04-25 22:28:06 -04:00
2004-04-25 22:54:06 -04:00
// If there is an error then take note of it..
2010-08-26 14:34:18 -04:00
if ( $this -> last_error = mysql_error ( $this -> dbh ) ) {
2004-04-25 22:54:06 -04:00
$this -> print_error ();
return false ;
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2011-05-27 11:46:56 -04:00
if ( preg_match ( '/^\s*(create|alter|truncate|drop) /i' , $query ) ) {
$return_val = $this -> result ;
} elseif ( preg_match ( '/^\s*(insert|delete|update|replace) /i' , $query ) ) {
2010-08-26 14:34:18 -04:00
$this -> rows_affected = mysql_affected_rows ( $this -> dbh );
2004-04-25 22:54:06 -04:00
// Take note of the insert_id
2011-05-27 11:46:56 -04:00
if ( preg_match ( '/^\s*(insert|replace) /i' , $query ) ) {
2010-08-26 14:34:18 -04:00
$this -> insert_id = mysql_insert_id ( $this -> dbh );
2004-04-25 22:54:06 -04:00
}
// Return number of rows affected
$return_val = $this -> rows_affected ;
2004-04-25 22:28:06 -04:00
} else {
2004-04-25 22:54:06 -04:00
$i = 0 ;
2010-11-12 17:44:16 -05:00
while ( $i < @ mysql_num_fields ( $this -> result ) ) {
$this -> col_info [ $i ] = @ mysql_fetch_field ( $this -> result );
2004-04-25 22:54:06 -04:00
$i ++ ;
}
2010-11-12 17:44:16 -05:00
$num_rows = 0 ;
while ( $row = @ mysql_fetch_object ( $this -> result ) ) {
$this -> last_result [ $num_rows ] = $row ;
$num_rows ++ ;
}
@ mysql_free_result ( $this -> result );
2003-05-28 04:41:04 -04:00
2004-04-25 22:54:06 -04:00
// Log number of rows the query returned
2010-02-22 17:53:54 -05:00
// and return number of rows selected
2010-11-12 17:44:16 -05:00
$this -> num_rows = $num_rows ;
$return_val = $num_rows ;
2004-04-25 22:54:06 -04:00
}
2003-05-28 04:41:04 -04:00
2004-04-25 22:54:06 -04:00
return $return_val ;
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2007-10-10 18:01:40 -04:00
/**
2009-04-10 17:57:40 -04:00
* Insert a row into a table .
*
* < code >
2010-02-23 17:04:29 -05:00
* wpdb :: insert ( 'table' , array ( 'column' => 'foo' , 'field' => 'bar' ) )
2009-04-10 17:57:40 -04:00
* wpdb :: insert ( 'table' , array ( 'column' => 'foo' , 'field' => 1337 ), array ( '%s' , '%d' ) )
* </ code >
2008-06-22 16:23:23 -04:00
*
* @ since 2.5 . 0
2009-04-10 17:57:40 -04:00
* @ see wpdb :: prepare ()
2010-02-23 17:04:29 -05:00
* @ see wpdb :: $field_types
* @ see wp_set_wpdb_vars ()
2008-06-22 16:23:23 -04:00
*
2009-04-10 17:37:19 -04:00
* @ param string $table table name
2010-02-27 10:45:09 -05:00
* @ param array $data Data to insert ( in column => value pairs ) . Both $data columns and $data values should be " raw " ( neither should be SQL escaped ) .
2010-02-23 17:04:29 -05:00
* @ 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 .
2011-09-19 01:15:44 -04:00
* 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 .
2009-04-10 17:57:40 -04:00
* @ return int | false The number of rows inserted , or false on error .
2007-10-10 18:01:40 -04:00
*/
2010-02-22 17:53:54 -05:00
function insert ( $table , $data , $format = null ) {
2010-02-27 10:45:09 -05:00
return $this -> _insert_replace_helper ( $table , $data , $format , 'INSERT' );
}
/**
* Replace a row into a table .
*
* < code >
* wpdb :: replace ( 'table' , array ( 'column' => 'foo' , 'field' => 'bar' ) )
* wpdb :: replace ( 'table' , array ( 'column' => 'foo' , 'field' => 1337 ), array ( '%s' , '%d' ) )
* </ code >
*
* @ since 3.0 . 0
* @ see wpdb :: prepare ()
* @ see wpdb :: $field_types
* @ 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 | 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 .
2011-09-19 01:15:44 -04:00
* 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 .
2010-02-27 10:45:09 -05:00
* @ return int | false The number of rows affected , or false on error .
*/
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 .
*
* @ access private
* @ since 3.0 . 0
* @ see wpdb :: prepare ()
* @ see wpdb :: $field_types
* @ see wp_set_wpdb_vars ()
*
* @ param string $table table name
2011-12-13 18:45:31 -05:00
* @ param array $data Data to insert ( in column => value pairs ) . Both $data columns and $data values should be " raw " ( neither should be SQL escaped ) .
2010-02-27 10:45:09 -05:00
* @ 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 .
2011-09-19 01:15:44 -04:00
* 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 .
2011-09-22 08:02:31 -04:00
* @ param string $type Optional . What type of operation is this ? INSERT or REPLACE . Defaults to INSERT .
2010-02-27 10:45:09 -05:00
* @ 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 ;
2009-03-05 19:50:19 -05:00
$formats = $format = ( array ) $format ;
2010-02-22 17:53:54 -05:00
$fields = array_keys ( $data );
2009-03-05 18:47:02 -05:00
$formatted_fields = array ();
2009-03-05 19:50:19 -05:00
foreach ( $fields as $field ) {
2010-02-22 17:53:54 -05:00
if ( ! empty ( $format ) )
$form = ( $form = array_shift ( $formats ) ) ? $form : $format [ 0 ];
elseif ( isset ( $this -> field_types [ $field ] ) )
2009-04-10 17:56:30 -04:00
$form = $this -> field_types [ $field ];
2009-03-05 19:50:19 -05:00
else
$form = '%s' ;
2009-03-05 18:47:02 -05:00
$formatted_fields [] = $form ;
}
2012-01-05 16:29:57 -05:00
$sql = " { $type } INTO ` $table ` (` " . implode ( '`,`' , $fields ) . " `) VALUES ( " . implode ( " , " , $formatted_fields ) . " ) " ;
2010-02-22 17:53:54 -05:00
return $this -> query ( $this -> prepare ( $sql , $data ) );
2007-10-10 18:01:40 -04:00
}
/**
2009-04-10 17:57:40 -04:00
* Update a row in the table
*
* < code >
2010-02-23 17:04:29 -05:00
* wpdb :: update ( 'table' , array ( 'column' => 'foo' , 'field' => 'bar' ), array ( 'ID' => 1 ) )
2009-04-10 17:57:40 -04:00
* wpdb :: update ( 'table' , array ( 'column' => 'foo' , 'field' => 1337 ), array ( 'ID' => 1 ), array ( '%s' , '%d' ), array ( '%d' ) )
* </ code >
2008-06-22 16:23:23 -04:00
*
* @ since 2.5 . 0
2009-04-10 17:57:40 -04:00
* @ see wpdb :: prepare ()
2010-02-23 17:04:29 -05:00
* @ see wpdb :: $field_types
* @ see wp_set_wpdb_vars ()
2008-06-22 16:23:23 -04:00
*
2009-04-10 17:37:19 -04:00
* @ param string $table table name
2010-02-23 17:04:29 -05:00
* @ 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 .
2011-09-19 01:15:44 -04:00
* 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 .
2011-12-13 18:45:31 -05:00
* @ 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 .
2009-04-10 17:57:40 -04:00
* @ return int | false The number of rows updated , or false on error .
2007-10-10 18:01:40 -04:00
*/
2010-02-22 17:53:54 -05:00
function update ( $table , $data , $where , $format = null , $where_format = null ) {
2010-02-23 17:04:29 -05:00
if ( ! is_array ( $data ) || ! is_array ( $where ) )
2009-03-05 18:47:02 -05:00
return false ;
$formats = $format = ( array ) $format ;
2007-10-12 21:44:25 -04:00
$bits = $wheres = array ();
2010-02-22 17:53:54 -05:00
foreach ( ( array ) array_keys ( $data ) as $field ) {
if ( ! empty ( $format ) )
$form = ( $form = array_shift ( $formats ) ) ? $form : $format [ 0 ];
2009-04-10 17:56:30 -04:00
elseif ( isset ( $this -> field_types [ $field ]) )
$form = $this -> field_types [ $field ];
2009-03-05 19:50:19 -05:00
else
$form = '%s' ;
$bits [] = " ` $field ` = { $form } " ;
2009-03-05 18:47:02 -05:00
}
2007-10-12 21:44:25 -04:00
2009-03-05 18:47:02 -05:00
$where_formats = $where_format = ( array ) $where_format ;
2010-02-22 17:53:54 -05:00
foreach ( ( array ) 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 ] ) )
2009-04-10 17:56:30 -04:00
$form = $this -> field_types [ $field ];
2009-03-05 19:50:19 -05:00
else
$form = '%s' ;
2009-04-10 17:37:19 -04:00
$wheres [] = " ` $field ` = { $form } " ;
2009-03-05 18:47:02 -05:00
}
2008-08-09 01:36:14 -04:00
2009-04-10 17:37:19 -04:00
$sql = " UPDATE ` $table ` SET " . implode ( ', ' , $bits ) . ' WHERE ' . implode ( ' AND ' , $wheres );
2010-02-22 17:53:54 -05:00
return $this -> query ( $this -> prepare ( $sql , array_merge ( array_values ( $data ), array_values ( $where ) ) ) );
2007-10-10 18:01:40 -04:00
}
2012-03-24 11:24:31 -04:00
/**
* Delete a row in the table
*
* < code >
* wpdb :: delete ( 'table' , array ( 'ID' => 1 ) )
* wpdb :: delete ( 'table' , array ( 'ID' => 1 ), array ( '%d' ) )
* </ code >
*
2012-03-27 08:00:39 -04:00
* @ since 3.4 . 0
2012-03-24 11:24:31 -04:00
* @ 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 .
*/
function delete ( $table , $where , $where_format = null ) {
if ( ! is_array ( $where ) )
return false ;
$bits = $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 ) );
}
2006-11-29 20:44:33 -05:00
/**
2008-06-22 16:23:23 -04:00
* Retrieve one variable from the database .
*
2009-04-10 17:57:40 -04:00
* 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 $query is null , this function returns the value in the specified column and row from the previous SQL result .
2008-06-22 16:23:23 -04:00
*
* @ since 0.71
*
2010-02-23 17:04:29 -05:00
* @ param string | null $query Optional . SQL query . Defaults to null , use the result from the previous query .
2011-12-13 18:45:31 -05:00
* @ param int $x Optional . Column of value to return . Indexed from 0.
* @ param int $y Optional . Row of value to return . Indexed from 0.
2010-02-23 17:04:29 -05:00
* @ return string | null Database query result ( as string ), or null on failure
2006-11-29 20:44:33 -05:00
*/
2010-02-22 17:53:54 -05:00
function get_var ( $query = null , $x = 0 , $y = 0 ) {
$this -> func_call = " \$ db->get_var( \" $query\ " , $x , $y ) " ;
2004-04-25 22:54:06 -04:00
if ( $query )
2010-02-22 17:53:54 -05:00
$this -> query ( $query );
2003-05-28 04:41:04 -04:00
2010-11-12 17:44:16 -05:00
// Extract var out of cached results based x,y vals
if ( ! empty ( $this -> last_result [ $y ] ) ) {
$values = array_values ( get_object_vars ( $this -> last_result [ $y ] ) );
2003-05-28 04:41:04 -04:00
}
2004-04-25 22:28:06 -04:00
// If there is a value return it else return null
2010-02-22 17:53:54 -05:00
return ( isset ( $values [ $x ] ) && $values [ $x ] !== '' ) ? $values [ $x ] : null ;
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2006-11-29 20:44:33 -05:00
/**
2008-06-22 16:23:23 -04:00
* Retrieve one row from the database .
*
2009-04-10 17:57:40 -04:00
* Executes a SQL query and returns the row from the SQL result .
*
2008-06-22 16:23:23 -04:00
* @ since 0.71
*
2009-04-10 17:57:40 -04:00
* @ param string | null $query SQL query .
2010-02-23 17:04:29 -05:00
* @ 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.
2011-09-05 15:08:15 -04:00
* @ return mixed Database query result in format specified by $output or null on failure
2006-11-29 20:44:33 -05:00
*/
2010-02-22 17:53:54 -05:00
function get_row ( $query = null , $output = OBJECT , $y = 0 ) {
2004-04-25 22:28:06 -04:00
$this -> func_call = " \$ db->get_row( \" $query\ " , $output , $y ) " ;
2004-04-25 22:54:06 -04:00
if ( $query )
2010-02-22 17:53:54 -05:00
$this -> query ( $query );
2007-08-09 21:33:56 -04:00
else
return null ;
2007-06-13 22:25:30 -04:00
2010-11-12 17:44:16 -05:00
if ( ! isset ( $this -> last_result [ $y ] ) )
2006-09-22 10:40:40 -04:00
return null ;
2003-05-28 04:41:04 -04:00
2004-04-25 22:28:06 -04:00
if ( $output == OBJECT ) {
2010-11-12 17:44:16 -05:00
return $this -> last_result [ $y ] ? $this -> last_result [ $y ] : null ;
2004-04-25 22:54:06 -04:00
} elseif ( $output == ARRAY_A ) {
2010-11-12 17:44:16 -05:00
return $this -> last_result [ $y ] ? get_object_vars ( $this -> last_result [ $y ] ) : null ;
2004-04-25 22:54:06 -04:00
} elseif ( $output == ARRAY_N ) {
2010-11-12 17:44:16 -05:00
return $this -> last_result [ $y ] ? array_values ( get_object_vars ( $this -> last_result [ $y ] ) ) : null ;
2004-04-25 22:54:06 -04:00
} else {
2012-01-26 15:34:27 -05:00
$this -> print_error ( " \$ db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N " );
2003-05-28 04:41:04 -04:00
}
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2006-11-29 20:44:33 -05:00
/**
2008-06-22 16:23:23 -04:00
* Retrieve one column from the database .
*
2009-04-10 17:57:40 -04:00
* 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 $query is null , this function returns the specified column from the previous SQL result .
*
2008-06-22 16:23:23 -04:00
* @ since 0.71
*
2010-02-23 17:04:29 -05:00
* @ param string | null $query Optional . SQL query . Defaults to previous query .
2010-02-22 17:53:54 -05:00
* @ param int $x Optional . Column to return . Indexed from 0.
* @ return array Database query result . Array indexed from 0 by SQL result row number .
2006-11-29 20:44:33 -05:00
*/
2010-02-22 17:53:54 -05:00
function get_col ( $query = null , $x = 0 ) {
2004-04-25 22:54:06 -04:00
if ( $query )
2010-02-22 17:53:54 -05:00
$this -> query ( $query );
2007-08-10 15:30:24 -04:00
2007-08-27 15:44:53 -04:00
$new_array = array ();
// Extract the column values
2010-11-12 17:44:16 -05:00
for ( $i = 0 , $j = count ( $this -> last_result ); $i < $j ; $i ++ ) {
$new_array [ $i ] = $this -> get_var ( null , $x , $i );
2004-04-25 22:28:06 -04:00
}
return $new_array ;
}
2003-05-28 04:41:04 -04:00
2006-11-29 20:44:33 -05:00
/**
2009-04-10 17:57:40 -04:00
* Retrieve an entire SQL result set from the database ( i . e . , many rows )
*
* Executes a SQL query and returns the entire SQL result .
2008-06-22 16:23:23 -04:00
*
* @ since 0.71
*
2009-04-10 17:57:40 -04:00
* @ param string $query SQL query .
2010-02-23 17:04:29 -05:00
* @ 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 .
2011-12-13 18:45:31 -05:00
* 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 .
2008-06-22 16:23:23 -04:00
* @ return mixed Database query results
2006-11-29 20:44:33 -05:00
*/
2010-02-22 17:53:54 -05:00
function get_results ( $query = null , $output = OBJECT ) {
2004-04-25 22:28:06 -04:00
$this -> func_call = " \$ db->get_results( \" $query\ " , $output ) " ;
2003-05-28 04:41:04 -04:00
2004-04-25 22:54:06 -04:00
if ( $query )
2010-02-22 17:53:54 -05:00
$this -> query ( $query );
2007-08-09 21:33:56 -04:00
else
return null ;
2003-05-28 04:41:04 -04:00
2010-02-15 05:00:39 -05:00
$new_array = array ();
2004-04-25 22:28:06 -04:00
if ( $output == OBJECT ) {
2008-02-25 17:00:27 -05:00
// Return an integer-keyed array of row objects
2010-11-12 17:44:16 -05:00
return $this -> last_result ;
2008-02-25 17:00:27 -05:00
} elseif ( $output == OBJECT_K ) {
// Return an array of row objects with keys from column 1
// (Duplicates are discarded)
2010-11-12 17:44:16 -05:00
foreach ( $this -> last_result as $row ) {
2011-10-28 11:48:44 -04:00
$var_by_ref = get_object_vars ( $row );
$key = array_shift ( $var_by_ref );
2010-04-10 08:39:25 -04:00
if ( ! isset ( $new_array [ $key ] ) )
2008-02-25 17:00:27 -05:00
$new_array [ $key ] = $row ;
}
return $new_array ;
2010-11-12 17:44:16 -05:00
} elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
// Return an integer-keyed array of...
if ( $this -> last_result ) {
foreach ( ( array ) $this -> last_result as $row ) {
if ( $output == ARRAY_N ) {
// ...integer-keyed row arrays
$new_array [] = array_values ( get_object_vars ( $row ) );
} else {
// ...column name-keyed row arrays
$new_array [] = get_object_vars ( $row );
}
}
2003-05-28 04:41:04 -04:00
}
2010-03-11 16:30:29 -05:00
return $new_array ;
2003-05-28 04:41:04 -04:00
}
2010-03-11 16:30:29 -05:00
return null ;
2004-04-25 22:28:06 -04:00
}
2003-05-28 04:41:04 -04:00
2006-11-29 20:44:33 -05:00
/**
2008-06-22 16:23:23 -04:00
* Retrieve column metadata from the last query .
*
* @ since 0.71
*
2010-02-22 17:53:54 -05:00
* @ 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 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
2008-06-22 16:23:23 -04:00
* @ return mixed Column Results
2006-11-29 20:44:33 -05:00
*/
2010-02-22 17:53:54 -05:00
function get_col_info ( $info_type = 'name' , $col_offset = - 1 ) {
2004-04-25 22:28:06 -04:00
if ( $this -> col_info ) {
if ( $col_offset == - 1 ) {
2010-04-10 08:39:25 -04:00
$i = 0 ;
2010-02-15 05:00:39 -05:00
$new_array = array ();
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $this -> col_info as $col ) {
2004-04-25 22:28:06 -04:00
$new_array [ $i ] = $col -> { $info_type };
$i ++ ;
2003-05-28 04:41:04 -04:00
}
2004-04-25 22:28:06 -04:00
return $new_array ;
} else {
return $this -> col_info [ $col_offset ] -> { $info_type };
2003-05-28 04:41:04 -04:00
}
}
}
2004-07-22 21:35:56 -04:00
2006-11-29 20:44:33 -05:00
/**
2008-06-22 16:23:23 -04:00
* Starts the timer , for debugging purposes .
*
* @ since 1.5 . 0
*
2009-04-10 17:57:40 -04:00
* @ return true
2006-11-29 20:44:33 -05:00
*/
2004-08-20 13:52:49 -04:00
function timer_start () {
2011-12-20 16:36:53 -05:00
$this -> time_start = microtime ( true );
2004-08-20 13:52:49 -04:00
return true ;
2004-07-22 21:35:56 -04:00
}
2006-02-12 02:53:23 -05:00
2006-11-29 20:44:33 -05:00
/**
2008-06-22 16:23:23 -04:00
* Stops the debugging timer .
*
* @ since 1.5 . 0
*
2011-12-20 16:36:53 -05:00
* @ return float Total time spent on the query , in seconds
2006-11-29 20:44:33 -05:00
*/
function timer_stop () {
2011-12-20 16:36:53 -05:00
return ( microtime ( true ) - $this -> time_start );
2004-07-22 21:35:56 -04:00
}
2006-11-29 20:44:33 -05:00
/**
2009-04-10 17:57:40 -04:00
* Wraps errors in a nice header and footer and dies .
*
* Will not die if wpdb :: $show_errors is true
2008-06-22 16:23:23 -04:00
*
* @ since 1.5 . 0
*
2009-08-21 13:00:53 -04:00
* @ param string $message The Error message
2010-02-23 17:04:29 -05:00
* @ param string $error_code Optional . A Computer readable string to identify the error .
2009-04-10 17:57:40 -04:00
* @ return false | void
2006-11-29 20:44:33 -05:00
*/
2010-02-22 17:53:54 -05:00
function bail ( $message , $error_code = '500' ) {
2007-12-19 21:10:09 -05:00
if ( ! $this -> show_errors ) {
2010-02-22 17:53:54 -05:00
if ( class_exists ( 'WP_Error' ) )
2009-08-21 13:00:53 -04:00
$this -> error = new WP_Error ( $error_code , $message );
2007-12-19 21:10:09 -05:00
else
$this -> error = $message ;
2006-07-10 01:29:10 -04:00
return false ;
2007-12-19 21:10:09 -05:00
}
2007-09-13 02:23:23 -04:00
wp_die ( $message );
2004-07-22 21:35:56 -04:00
}
2007-12-19 21:10:09 -05:00
2007-10-06 04:40:54 -04:00
/**
2010-02-24 15:13:23 -05:00
* Whether MySQL database is at least the required minimum version .
2008-06-22 16:23:23 -04:00
*
* @ since 2.5 . 0
* @ uses $wp_version
2010-02-22 17:53:54 -05:00
* @ uses $required_mysql_version
2008-06-22 16:23:23 -04:00
*
* @ return WP_Error
2007-10-06 04:40:54 -04:00
*/
2010-02-15 05:00:39 -05:00
function check_database_version () {
2009-12-22 06:49:22 -05:00
global $wp_version , $required_mysql_version ;
// Make sure the server has the required MySQL version
if ( version_compare ( $this -> db_version (), $required_mysql_version , '<' ) )
2010-02-22 17:53:54 -05:00
return new WP_Error ( 'database_version' , sprintf ( __ ( '<strong>ERROR</strong>: WordPress %1$s requires MySQL %2$s or higher' ), $wp_version , $required_mysql_version ));
2007-10-06 04:40:54 -04:00
}
/**
2010-02-24 15:13:23 -05:00
* Whether the database supports collation .
2008-06-22 16:23:23 -04:00
*
* Called when WordPress is generating the table scheme .
*
* @ since 2.5 . 0
*
* @ return bool True if collation is supported , false if version does not
2007-10-06 04:40:54 -04:00
*/
2009-08-21 13:00:53 -04:00
function supports_collation () {
2008-08-26 19:57:48 -04:00
return $this -> has_cap ( 'collation' );
2007-10-06 04:40:54 -04:00
}
2007-11-20 19:14:58 -05:00
2008-08-26 15:18:58 -04:00
/**
2010-02-22 17:53:54 -05:00
* Determine if a database supports a particular feature
*
2010-12-20 07:49:18 -05:00
* @ since 2.7 . 0
2010-02-22 17:53:54 -05:00
* @ see wpdb :: db_version ()
*
2008-08-26 19:57:48 -04:00
* @ param string $db_cap the feature
* @ return bool
2008-08-26 15:18:58 -04:00
*/
2008-08-26 19:57:48 -04:00
function has_cap ( $db_cap ) {
$version = $this -> db_version ();
2010-02-22 17:53:54 -05:00
switch ( strtolower ( $db_cap ) ) {
case 'collation' : // @since 2.5.0
case 'group_concat' : // @since 2.7
case 'subqueries' : // @since 2.7
return version_compare ( $version , '4.1' , '>=' );
2010-08-26 14:34:18 -04:00
case 'set_charset' :
return version_compare ( $version , '5.0.7' , '>=' );
2010-02-22 17:53:54 -05:00
};
2008-08-26 19:57:48 -04:00
return false ;
2008-08-26 15:18:58 -04:00
}
2007-11-20 19:14:58 -05:00
/**
2008-06-22 16:23:23 -04:00
* Retrieve the name of the function that called wpdb .
*
2010-02-03 16:38:09 -05:00
* Searches up the list of functions until it reaches
2008-06-22 16:23:23 -04:00
* the one that would most logically had called this method .
*
* @ since 2.5 . 0
*
* @ return string The name of the calling function
2007-11-20 19:14:58 -05:00
*/
function get_caller () {
2012-01-28 06:56:50 -05:00
return wp_debug_backtrace_summary ( __CLASS__ );
2007-11-20 19:14:58 -05:00
}
2008-08-26 18:30:56 -04:00
/**
2010-02-23 17:04:29 -05:00
* The database version number .
*
2010-12-20 07:49:18 -05:00
* @ since 2.7 . 0
*
2008-08-26 18:30:56 -04:00
* @ return false | string false on failure , version number on success
*/
function db_version () {
2010-02-22 17:53:54 -05:00
return preg_replace ( '/[^0-9.].*/' , '' , mysql_get_server_info ( $this -> dbh ) );
2008-08-26 18:30:56 -04:00
}
2004-04-25 22:28:06 -04:00
}