2003-05-28 08:41:04 +00:00
< ? php
2008-06-22 20:23:23 +00: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 22:53:54 +00:00
define ( 'EZSQL_VERSION' , 'WP1.25' );
2008-06-22 20:23:23 +00:00
/**
* @ since 0.71
*/
2010-02-22 22:53:54 +00:00
define ( 'OBJECT' , 'OBJECT' , true );
2008-06-22 20:23:23 +00:00
/**
* @ since { @ internal Version Unknown }}
*/
2010-02-22 22:53:54 +00:00
define ( 'OBJECT_K' , 'OBJECT_K' , false );
2008-06-22 20:23:23 +00:00
/**
* @ since 0.71
*/
2010-02-22 22:53:54 +00:00
define ( 'ARRAY_A' , 'ARRAY_A' , false );
2008-06-22 20:23:23 +00:00
/**
* @ since 0.71
*/
2010-02-22 22:53:54 +00:00
define ( 'ARRAY_N' , 'ARRAY_N' , false );
2004-08-20 17:52:49 +00:00
2008-06-22 20:23:23 +00:00
/**
* WordPress Database Access Abstraction Object
*
* It is possible to replace this class with your own
2008-10-02 16:45:28 +00:00
* by setting the $wpdb global variable in wp - content / db . php
2008-06-22 20:23:23 +00:00
* file with your class . You can name it wpdb also , since
* this file will not be included , if the other file is
* available .
*
* @ link http :// codex . wordpress . org / Function_Reference / wpdb_Class
*
* @ package WordPress
* @ subpackage Database
* @ since 0.71
* @ final
*/
2004-04-26 02:28:06 +00:00
class wpdb {
2008-06-22 20:23:23 +00:00
/**
* Whether to show SQL / DB errors
*
* @ since 0.71
* @ access private
* @ var bool
*/
2007-12-16 21:38:24 +00:00
var $show_errors = false ;
2008-06-22 20:23:23 +00:00
/**
* Whether to suppress errors during the DB bootstrapping .
*
* @ access private
2010-02-22 22:53:54 +00:00
* @ since 2.5
2008-06-22 20:23:23 +00:00
* @ var bool
*/
2008-03-12 22:41:43 +00:00
var $suppress_errors = false ;
2008-06-22 20:23:23 +00:00
/**
* The last error during query .
*
2010-02-22 22:53:54 +00:00
* @ see get_last_error ()
* @ since 2.5
* @ access private
2008-06-22 20:23:23 +00:00
* @ var string
*/
2008-03-20 23:34:32 +00:00
var $last_error = '' ;
2008-06-22 20:23:23 +00:00
/**
* Amount of queries made
*
* @ since 1.2 . 0
* @ access private
* @ var int
*/
2006-02-12 07:53:23 +00:00
var $num_queries = 0 ;
2008-06-22 20:23:23 +00:00
2010-02-22 22:53:54 +00:00
/**
* Count of rows returned by previous query
*
* @ since 1.2
* @ var int
*/
2010-02-23 09:06:50 +00:00
var $num_rows = 0 ;
2010-02-22 22:53:54 +00:00
/**
* Count of affected rows by previous query
*
* @ since 0.71
* @ var int
*/
var $rows_affected = 0 ;
2008-06-22 20:23:23 +00:00
/**
* Saved result of the last query made
*
* @ since 1.2 . 0
* @ access private
* @ var array
*/
2004-04-26 02:54:06 +00:00
var $last_query ;
2008-06-22 20:23:23 +00:00
2010-02-22 22:53:54 +00:00
/**
* Results of the last query made
*
* @ since { @ internal Version Unknown }}
* @ var mixed
*/
var $last_result ;
2008-06-22 20:23:23 +00:00
/**
* Saved info on the table column
*
* @ since 1.2 . 0
* @ access private
* @ var array
*/
2004-04-26 02:54:06 +00:00
var $col_info ;
2008-06-22 20:23:23 +00:00
/**
* Saved queries that were executed
*
* @ since 1.5 . 0
* @ access private
* @ var array
*/
2004-08-20 17:52:49 +00:00
var $queries ;
2008-06-22 20:23:23 +00: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-31 03:59:18 +00:00
var $prefix = '' ;
2008-06-22 20:23:23 +00:00
/**
* Whether the database queries are ready to start executing .
*
* @ since 2.5 . 0
* @ access private
* @ var bool
*/
2007-12-21 19:30:08 +00:00
var $ready = false ;
2010-02-22 22:53:54 +00:00
/**
* { @ internal Missing Description }}
*
* @ since 3.0 . 0
* @ var int
*/
2010-01-08 19:26:00 +00:00
var $blogid = 0 ;
2010-02-22 22:53:54 +00:00
/**
* { @ internal Missing Description }}
*
* @ since 3.0 . 0
* @ var int
*/
2010-01-08 19:26:00 +00:00
var $siteid = 0 ;
2003-05-28 08:41:04 +00:00
2008-06-22 20:23:23 +00:00
/**
* WordPress Posts table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 08:22:18 +00:00
var $posts ;
2008-06-22 20:23:23 +00:00
/**
* WordPress Users table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 08:22:18 +00:00
var $users ;
2008-06-22 20:23:23 +00:00
/**
* WordPress Comments table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 08:22:18 +00:00
var $comments ;
2008-06-22 20:23:23 +00:00
/**
* WordPress Links table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 08:22:18 +00:00
var $links ;
2008-06-22 20:23:23 +00:00
/**
* WordPress Options table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 08:22:18 +00:00
var $options ;
2008-06-22 20:23:23 +00:00
/**
* WordPress Post Metadata table
*
* @ since { @ internal Version Unknown }}
* @ access public
* @ var string
*/
2004-05-24 08:22:18 +00:00
var $postmeta ;
2008-06-22 20:23:23 +00:00
2009-09-17 20:17:33 +00:00
/**
* WordPress Comment Metadata table
*
* @ since 2.9
* @ access public
* @ var string
*/
var $commentmeta ;
2008-06-22 20:23:23 +00:00
/**
* WordPress User Metadata table
*
* @ since 2.3 . 0
* @ access public
* @ var string
*/
2007-09-05 23:17:41 +00:00
var $usermeta ;
2008-06-22 20:23:23 +00:00
/**
* WordPress Terms table
*
* @ since 2.3 . 0
* @ access public
* @ var string
*/
2007-05-22 05:12:38 +00:00
var $terms ;
2008-06-22 20:23:23 +00:00
/**
* WordPress Term Taxonomy table
*
* @ since 2.3 . 0
* @ access public
* @ var string
*/
2007-05-22 05:12:38 +00:00
var $term_taxonomy ;
2008-06-22 20:23:23 +00:00
/**
* WordPress Term Relationships table
*
* @ since 2.3 . 0
* @ access public
* @ var string
*/
2007-05-22 05:12:38 +00:00
var $term_relationships ;
2008-06-22 20:23:23 +00:00
/**
2010-02-19 19:57:03 +00:00
* List of WordPress per - blog tables
2008-06-22 20:23:23 +00:00
*
* @ since { @ internal Version Unknown }}
* @ access private
2010-02-19 19:57:03 +00:00
* @ see wpdb :: tables ()
2008-06-22 20:23:23 +00:00
* @ var array
*/
2010-02-19 19:57:03 +00:00
var $tables = array ( 'posts' , 'comments' , 'links' , 'options' , 'postmeta' ,
'terms' , 'term_taxonomy' , 'term_relationships' , 'commentmeta' );
2008-06-22 20:23:23 +00:00
2009-09-06 18:46:27 +00:00
/**
* List of deprecated WordPress tables
*
2010-02-22 22:53:54 +00:00
* @ deprecated
2009-09-06 18:46:27 +00:00
* @ since 2.9 . 0
* @ access private
2010-02-19 19:57:03 +00:00
* @ see wpdb :: tables ()
2009-09-06 18:46:27 +00:00
* @ var array
*/
2010-02-19 19:57:03 +00:00
var $old_tables = array ( 'categories' , 'post2cat' , 'link2cat' );
2009-09-06 18:46:27 +00:00
2010-02-19 19:57:03 +00:00
/**
* Multisite Blogs table
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
var $blogs ;
/**
* Multisite Signups table
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
var $signups ;
/**
* Multisite Sites table
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
var $site ;
2009-09-14 14:03:32 +00:00
2009-04-10 21:56:30 +00:00
/**
2010-02-19 19:57:03 +00:00
* Multisite Site Metadata table
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
var $sitemeta ;
/**
* Multisite Sitewide Terms table
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
var $sitecategories ;
/**
* Multisite Registration Log table
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
var $registration_log ;
/**
* Multisite Blog Versions table
*
* @ since 3.0 . 0
* @ access public
* @ var string
*/
var $blog_versions ;
/**
2010-02-23 09:06:50 +00:00
* List of WordPress global tables
2010-02-19 19:57:03 +00:00
*
* @ since 3.0 . 0
* @ access private
* @ see wpdb :: tables ()
* @ var array
*/
2010-02-23 09:06:50 +00:00
var $global_tables = array ( 'users' , 'usermeta' );
2010-02-19 19:57:03 +00:00
/**
2010-02-23 09:06:50 +00:00
* List of Multisite global tables
2010-02-19 19:57:03 +00:00
*
* @ since 3.0 . 0
* @ access private
* @ see wpdb :: tables ()
* @ var array
*/
2010-02-23 09:06:50 +00:00
var $ms_global_tables = array ( 'blogs' , 'signups' , 'site' , 'sitemeta' ,
'sitecategories' , 'registration_log' , 'blog_versions' );
2010-02-19 19:57:03 +00:00
/**
2010-02-22 22:53:54 +00:00
* Format specifiers for DB columns . Columns not listed here default to % s . Initialized during WP load .
2010-02-23 09:06:50 +00:00
*
2010-02-22 22:53:54 +00:00
* Keys are column names , values are format types : 'ID' => '%d'
2009-04-10 21:56:30 +00:00
*
* @ since 2.8 . 0
* @ see wpdb : prepare ()
* @ see wpdb : insert ()
* @ see wpdb : update ()
2010-02-19 19:57:03 +00:00
* @ see wp_set_wpdb_vars ()
2009-04-10 21:56:30 +00:00
* @ access public
2010-01-19 17:28:48 +00:00
* @ var array
2009-04-10 21:56:30 +00:00
*/
2009-04-14 22:34:51 +00:00
var $field_types = array ();
2009-04-10 21:56:30 +00:00
2008-06-22 20:23:23 +00:00
/**
* Database table columns charset
*
* @ since 2.2 . 0
* @ access public
* @ var string
*/
2007-02-02 00:04:35 +00:00
var $charset ;
2008-06-22 20:23:23 +00:00
/**
* Database table columns collate
*
* @ since 2.2 . 0
* @ access public
* @ var string
*/
2007-02-02 00:04:35 +00:00
var $collate ;
2009-02-19 19:01:57 +00:00
/**
* Whether to use mysql_real_escape_string
*
* @ since 2.8 . 0
* @ access public
* @ var bool
*/
var $real_escape = false ;
2009-08-21 17:00:53 +00:00
/**
* Database Username
*
* @ since 2.9 . 0
* @ access private
* @ var string
*/
var $dbuser ;
2006-11-30 01:44:33 +00:00
/**
* Connects to the database server and selects a database
2008-06-22 20:23:23 +00:00
*
* PHP4 compatibility layer for calling the PHP5 constructor .
*
* @ uses wpdb :: __construct () Passes parameters and returns result
* @ since 0.71
*
* @ param string $dbuser MySQL database user
* @ param string $dbpassword MySQL database password
* @ param string $dbname MySQL database name
* @ param string $dbhost MySQL database host
2006-11-30 01:44:33 +00:00
*/
2010-02-22 22:53:54 +00:00
function wpdb ( $dbuser , $dbpassword , $dbname , $dbhost ) {
2010-02-19 01:03:58 +00:00
if ( defined ( 'WP_USE_MULTIPLE_DB' ) && WP_USE_MULTIPLE_DB )
2010-01-08 19:26:00 +00:00
$this -> db_connect ();
2010-02-22 22:53:54 +00:00
return $this -> __construct ( $dbuser , $dbpassword , $dbname , $dbhost );
2007-01-06 23:36:51 +00:00
}
2007-02-27 15:24:54 +00:00
2008-06-22 20:23:23 +00: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 .
*
* @ 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 22:53:54 +00:00
function __construct ( $dbuser , $dbpassword , $dbname , $dbhost ) {
register_shutdown_function ( array ( & $this , '__destruct' ) );
2007-01-06 23:36:51 +00:00
2010-02-19 01:03:58 +00:00
if ( WP_DEBUG )
2007-12-22 17:45:30 +00:00
$this -> show_errors ();
2010-01-18 22:21:36 +00:00
if ( is_multisite () ) {
$this -> charset = 'utf8' ;
2010-02-19 01:03:58 +00:00
if ( defined ( 'DB_COLLATE' ) && DB_COLLATE )
$this -> collate = DB_COLLATE ;
2010-01-18 22:21:36 +00:00
else
$this -> collate = 'utf8_general_ci' ;
2010-02-19 01:03:58 +00:00
} elseif ( defined ( 'DB_COLLATE' ) ) {
$this -> collate = DB_COLLATE ;
2010-01-18 22:21:36 +00:00
}
2010-01-08 19:26:00 +00:00
2010-02-22 22:53:54 +00:00
if ( defined ( 'DB_CHARSET' ) )
2007-02-02 00:04:35 +00:00
$this -> charset = DB_CHARSET ;
2009-08-21 17:00:53 +00:00
$this -> dbuser = $dbuser ;
2010-02-22 22:53:54 +00:00
$this -> dbh = @ mysql_connect ( $dbhost , $dbuser , $dbpassword , true );
if ( ! $this -> dbh ) {
$this -> bail ( sprintf ( /*WP_I18N_DB_CONN_ERROR*/ "
2004-07-23 01:35:56 +00:00
< h1 > Error establishing a database connection </ h1 >
2008-06-23 15:40:43 +00: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 >
2004-07-23 01:35:56 +00: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 >
2010-02-22 22:53:54 +00:00
" /*/WP_I18N_DB_CONN_ERROR*/, $dbhost ), 'db_connect_fail' );
2007-12-21 19:30:08 +00:00
return ;
2003-05-28 08:41:04 +00:00
}
2007-12-22 06:24:48 +00:00
$this -> ready = true ;
2010-02-22 22:53:54 +00:00
if ( $this -> has_cap ( 'collation' ) && ! empty ( $this -> charset ) ) {
if ( function_exists ( 'mysql_set_charset' ) ) {
mysql_set_charset ( $this -> charset , $this -> dbh );
2009-12-15 21:01:57 +00:00
$this -> real_escape = true ;
} else {
2010-02-22 22:53:54 +00:00
$query = $this -> prepare ( 'SET NAMES %s' , $this -> charset );
if ( ! empty ( $this -> collate ) )
$query .= $this -> prepare ( ' COLLATE %s' , $this -> collate );
$this -> query ( $query );
2008-03-30 17:56:27 +00:00
}
}
2008-08-09 05:36:14 +00:00
2010-02-22 22:53:54 +00:00
$this -> select ( $dbname , $this -> dbh );
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2008-06-22 20:23:23 +00:00
/**
* PHP5 style destructor and will run when database object is destroyed .
*
* @ since 2.0 . 8
2010-02-22 22:53:54 +00:00
* @ return bool true
2008-06-22 20:23:23 +00:00
*/
2007-01-06 23:36:51 +00:00
function __destruct () {
2007-09-03 23:32:58 +00:00
return true ;
2007-01-06 23:36:51 +00:00
}
2008-06-22 20:23:23 +00:00
/**
* Sets the table prefix for the WordPress tables .
*
* @ since 2.5 . 0
*
* @ param string $prefix Alphanumeric name for the new prefix .
2009-04-10 21:57:40 +00:00
* @ return string | WP_Error Old prefix or WP_Error on error
2008-06-22 20:23:23 +00:00
*/
2010-02-19 19:57:03 +00:00
function set_prefix ( $prefix ) {
2007-10-31 03:59:18 +00:00
2010-02-22 22:53:54 +00:00
if ( preg_match ( '|[^a-z0-9_]|i' , $prefix ) )
2008-06-23 15:40:43 +00:00
return new WP_Error ( 'invalid_db_prefix' , /*WP_I18N_DB_BAD_PREFIX*/ 'Invalid database prefix' /*/WP_I18N_DB_BAD_PREFIX*/ );
2007-10-31 03:59:18 +00:00
2010-02-22 22:53:54 +00:00
$old_prefix = is_multisite () ? '' : $prefix ;
2010-01-18 22:21:36 +00:00
if ( isset ( $this -> base_prefix ) )
2010-01-08 19:26:00 +00:00
$old_prefix = $this -> base_prefix ;
$this -> base_prefix = $prefix ;
2010-02-23 09:06:50 +00:00
foreach ( $this -> tables ( 'global' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
2010-01-08 19:26:00 +00:00
2010-02-22 22:53:54 +00:00
if ( defined ( 'VHOST' ) && empty ( $this -> blogid ) )
2010-01-08 19:26:00 +00:00
return $old_prefix ;
$this -> prefix = $this -> get_blog_prefix ( $this -> blogid );
2007-10-31 03:59:18 +00:00
2010-02-23 09:06:50 +00:00
foreach ( ( array ) $this -> tables ( 'blog' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
2010-02-19 19:57:03 +00:00
2010-02-23 09:06:50 +00:00
foreach ( ( array ) $this -> tables ( 'old' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
2007-10-31 03:59:18 +00:00
return $old_prefix ;
}
2010-02-22 22:53:54 +00:00
/**
* Sets blog id .
*
* @ since 3.0 . 0
* @ access public
* @ param string $blog_id
* @ param string $site_id . Optional .
* @ return string previous blog id
2010-02-23 09:06:50 +00:00
*/
2010-02-22 22:53:54 +00:00
function set_blog_id ( $blog_id , $site_id = '' ) {
if ( ! empty ( $site_id ) )
2010-01-08 19:26:00 +00:00
$this -> siteid = $site_id ;
2010-02-22 22:53:54 +00:00
$old_blog_id = $this -> blogid ;
2010-01-08 19:26:00 +00:00
$this -> blogid = $blog_id ;
$this -> prefix = $this -> get_blog_prefix ( $this -> blogid );
2010-02-23 09:06:50 +00:00
foreach ( $this -> tables ( 'blog' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
2010-02-19 19:57:03 +00:00
2010-02-23 09:06:50 +00:00
foreach ( $this -> tables ( 'old' ) as $table => $prefixed_table )
$this -> $table = $prefixed_table ;
2010-01-08 19:26:00 +00:00
return $old_blog_id ;
}
2010-02-22 22:53:54 +00:00
/**
* Gets blog prefix .
*
* @ uses is_multisite ()
* @ since 3.0 . 0
* @ param int $blog_id . Optional .
* @ return string Blog prefix .
*/
function get_blog_prefix ( $blog_id = 0 ) {
2010-02-13 19:57:43 +00:00
if ( is_multisite () && $blog_id ) {
if ( defined ( 'MULTISITE' ) && ( $blog_id == 0 || $blog_id == 1 ) )
return $this -> base_prefix ;
else
return $this -> base_prefix . $blog_id . '_' ;
2010-01-08 19:26:00 +00:00
} else {
return $this -> base_prefix ;
}
}
2010-02-19 19:57:03 +00:00
/**
* Returns an array of WordPress tables .
*
2010-02-23 09:06:50 +00:00
* Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
* override the WordPress users and usersmeta tables that would otherwise
* be determined by the prefix .
*
2010-02-19 19:57:03 +00:00
* @ since 3.0 . 0
* @ uses wpdb :: tables
* @ uses wpdb :: old_tables
* @ uses wpdb :: global_tables
2010-02-23 09:06:50 +00:00
* @ uses wpdb :: ms_global_tables
2010-02-19 19:57:03 +00:00
* @ uses is_multisite ()
*
* @ param string $scope Can be all , global , blog , or old tables . Default all .
2010-02-23 09:06:50 +00:00
* All returns the blog tables for the queried blog and all global tables .
2010-02-23 09:08:50 +00:00
* @ param bool $prefix Whether to include table prefixes . Default true . If blog
2010-02-23 09:06:50 +00:00
* prefix is requested , then the custom users and usermeta tables will be mapped .
* @ param int $blog_id The blog_id to prefix . Defaults to main blog . 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 ) {
2010-02-19 19:57:03 +00:00
switch ( $scope ) {
case 'old' :
$tables = $this -> old_tables ;
break ;
case 'blog' :
$tables = $this -> tables ;
break ;
case 'global' :
2010-02-23 09:06:50 +00:00
$tables = $this -> global_tables ;
if ( is_multisite () )
$tables = array_merge ( $tables , $this -> ms_global_tables );
2010-02-19 19:57:03 +00:00
break ;
case 'all' :
$tables = array_merge ( $this -> global_tables , $this -> tables );
if ( is_multisite () )
2010-02-23 09:06:50 +00:00
$tables = array_merge ( $tables , $this -> ms_global_tables );
2010-02-19 19:57:03 +00:00
break ;
}
if ( $prefix ) {
$prefix = $this -> get_blog_prefix ( $blog_id );
2010-02-23 09:06:50 +00:00
$base_prefix = $this -> base_prefix ;
$global_tables = array_merge ( $this -> global_tables , $this -> ms_global_tables );
2010-02-20 10:50:57 +00:00
foreach ( $tables as $k => $table ) {
2010-02-23 09:06:50 +00:00
if ( in_array ( $table , $global_tables ) )
$tables [ $table ] = $base_prefix . $table ;
else
$tables [ $table ] = $prefix . $table ;
unset ( $tables [ $k ] );
2010-02-19 19:57:03 +00:00
}
2010-02-23 09:06:50 +00: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 19:57:03 +00:00
}
return $tables ;
}
2006-11-30 01:44:33 +00:00
/**
2008-06-22 20:23:23 +00: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
* @ return null Always null .
2006-11-30 01:44:33 +00:00
*/
2010-02-22 22:53:54 +00:00
function select ( $db , & $dbh ) {
if ( !@ mysql_select_db ( $db , $dbh ) ) {
2007-12-22 06:24:48 +00:00
$this -> ready = false ;
2010-02-22 22:53:54 +00:00
$this -> bail ( sprintf ( /*WP_I18N_DB_SELECT_DB*/ '
2004-07-23 01:35:56 +00:00
< h1 > Can & #8217;t select database</h1>
2008-06-23 15:40:43 +00: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-23 01:35:56 +00:00
< ul >
< li > Are you sure it exists ? </ li >
2008-06-23 15:40:43 +00:00
< li > Does the user < code >% 2 $s </ code > have permission to use the < code >% 1 $s </ code > database ? </ li >
2008-11-28 04:40:20 +00: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-23 01:35:56 +00:00
</ ul >
2010-02-22 22:53:54 +00:00
< p > If you don\ 't know how to setup 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' );
2007-12-21 19:30:08 +00:00
return ;
2003-05-28 08:41:04 +00:00
}
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2010-02-22 22:53:54 +00:00
/**
* Weak escape
*
* @ see addslashes ()
* @ since unknown
* @ access private
*
* @ param string $string
* @ return string
*/
function _weak_escape ( $string ) {
return addslashes ( $string );
2009-02-20 19:05:12 +00:00
}
2010-02-22 22:53:54 +00:00
/**
* Real escape
*
* @ see mysql_real_escape_string ()
* @ see addslashes ()
* @ since 2.8
* @ access private
*
* @ param string $string to escape
* @ return string escaped
*/
function _real_escape ( $string ) {
2009-02-20 19:05:12 +00:00
if ( $this -> dbh && $this -> real_escape )
return mysql_real_escape_string ( $string , $this -> dbh );
else
2009-03-18 02:43:45 +00:00
return addslashes ( $string );
2009-02-20 19:05:12 +00:00
}
2010-02-22 22:53:54 +00:00
/**
* Escape data .
*
* @ see esc_sql ()
* @ since 2.8
* @ access private
*
* @ param string | array $data
* @ return string | array escaped
*/
function _escape ( $data ) {
if ( is_array ( $data ) ) {
2009-02-20 19:05:12 +00: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-30 01:44:33 +00:00
/**
2009-02-20 19:05:12 +00:00
* Escapes content for insertion into the database using addslashes (), for security
2006-11-30 01:44:33 +00:00
*
2008-06-22 20:23:23 +00:00
* @ since 0.71
*
2010-02-22 22:53:54 +00:00
* @ param string | array $data to escape
* @ return string | array escaped as query safe string
2006-11-30 01:44:33 +00:00
*/
2010-02-22 22:53:54 +00:00
function escape ( $data ) {
if ( is_array ( $data ) ) {
2009-02-20 19:05:12 +00:00
foreach ( ( array ) $data as $k => $v ) {
2010-02-22 22:53:54 +00:00
if ( is_array ( $v ) )
2009-02-20 19:05:12 +00:00
$data [ $k ] = $this -> escape ( $v );
else
$data [ $k ] = $this -> _weak_escape ( $v );
}
} else {
$data = $this -> _weak_escape ( $data );
}
return $data ;
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2007-07-04 16:18:57 +00:00
/**
* Escapes content by reference for insertion into the database , for security
2008-06-22 20:23:23 +00:00
*
* @ since 2.3 . 0
*
2010-02-22 22:53:54 +00:00
* @ param string $string to escape
* @ return void
2007-07-04 16:18:57 +00:00
*/
2010-02-22 22:53:54 +00:00
function escape_by_ref ( & $string ) {
2009-02-20 19:05:12 +00:00
$string = $this -> _real_escape ( $string );
2007-07-04 16:18:57 +00:00
}
/**
2009-04-10 21:57:40 +00:00
* Prepares a SQL query for safe execution . Uses sprintf () - like syntax .
2008-06-22 20:23:23 +00:00
*
2010-02-23 09:06:50 +00:00
* The following directives can be used in the query format string :
* % d ( decimal number )
2010-02-22 22:53:54 +00:00
* % s ( string )
2010-02-23 09:06:50 +00:00
* %% ( literal percentage sign - no argument needed )
2010-02-22 22:53:54 +00:00
*
2010-02-23 09:06:50 +00:00
* Both % d and % s are to be left unquoted in the query string and
2010-02-22 22:53:54 +00:00
* they need an argument passed for them . Literals ( % ) as parts of
* the query must be properly written as %%.
*
2009-04-10 21:57:40 +00:00
* This function only supports a small subset of the sprintf syntax ; it only supports % d ( decimal number ), % s ( string ) .
* 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 >
* wpdb :: prepare ( " SELECT * FROM `table` WHERE `column` = %s AND `field` = %d " , " foo " , 1337 )
* </ code >
*
* @ link http :// php . net / sprintf Description of syntax .
2008-06-22 20:23:23 +00:00
* @ since 2.3 . 0
*
2009-04-10 21:57:40 +00:00
* @ param string $query Query statement with sprintf () - like placeholders
2010-02-22 22:53:54 +00: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 21:57:40 +00:00
if ( is_null ( $query ) )
2007-07-04 16:18:57 +00:00
return ;
$args = func_get_args ();
2010-02-22 22:53:54 +00:00
array_shift ( $args );
2009-04-10 21:57:40 +00:00
// If args were passed as an array (as in vsprintf), move them up
2010-02-22 22:53:54 +00:00
if ( isset ( $args [ 0 ] ) && is_array ( $args [ 0 ]) )
2009-03-05 22:15:17 +00:00
$args = $args [ 0 ];
2010-02-22 22:53:54 +00:00
$query = str_replace ( " '%s' " , '%s' , $query ); // in case someone mistakenly already singlequoted it
$query = str_replace ( '"%s"' , '%s' , $query ); // doublequote unquoting
$query = str_replace ( '%s' , " '%s' " , $query ); // quote the strings
array_walk ( $args , array ( & $this , 'escape_by_ref' ) );
return @ vsprintf ( $query , $args );
2007-07-04 16:18:57 +00:00
}
2008-06-22 20:23:23 +00: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 22:53:54 +00:00
function print_error ( $str = '' ) {
2004-04-26 02:28:06 +00:00
global $EZSQL_ERROR ;
2008-03-12 22:41:43 +00:00
2010-02-22 22:53:54 +00:00
if ( ! $str )
$str = mysql_error ( $this -> dbh );
$EZSQL_ERROR [] = array ( 'query' => $this -> last_query , 'error_str' => $str );
2004-04-26 02:28:06 +00:00
2008-03-12 22:41:43 +00:00
if ( $this -> suppress_errors )
return false ;
2007-12-16 21:38:24 +00:00
if ( $caller = $this -> get_caller () )
2008-06-23 15:40:43 +00:00
$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 );
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 );
2008-03-20 19:08:40 +00:00
$log_error = true ;
if ( ! function_exists ( 'error_log' ) )
$log_error = false ;
$log_file = @ ini_get ( 'error_log' );
2008-10-16 17:35:39 +00:00
if ( ! empty ( $log_file ) && ( 'syslog' != $log_file ) && !@ is_writable ( $log_file ) )
2008-03-20 19:08:40 +00:00
$log_error = false ;
if ( $log_error )
@ error_log ( $error_str , 0 );
2007-12-16 21:38:24 +00:00
2004-04-26 02:28:06 +00:00
// Is error output turned on or not..
2007-12-16 21:38:24 +00:00
if ( ! $this -> show_errors )
2006-02-12 07:53:23 +00:00
return false ;
2007-12-16 21:38:24 +00:00
2010-01-18 22:21:36 +00: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-19 01:03:58 +00:00
error_log ( $msg , 3 , ERRORLOGFILE );
2010-01-18 22:21:36 +00:00
if ( defined ( 'DIEONDBERROR' ) )
die ( $msg );
} else {
2010-02-22 22:53:54 +00:00
$str = htmlspecialchars ( $str , ENT_QUOTES );
$query = htmlspecialchars ( $this -> last_query , ENT_QUOTES );
2010-01-18 22:21:36 +00:00
print " <div id='error'>
< p class = 'wpdberror' >< strong > WordPress database error :</ strong > [ $str ] < br />
< code > $query </ code ></ p >
</ div > " ;
}
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2008-06-22 20:23:23 +00: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 22:53:54 +00:00
* @ see wpdb :: hide_errors ()
2008-06-22 20:23:23 +00:00
*
* @ param bool $show Whether to show or hide errors
* @ return bool Old value for showing errors .
*/
2007-12-16 21:38:24 +00:00
function show_errors ( $show = true ) {
$errors = $this -> show_errors ;
$this -> show_errors = $show ;
return $errors ;
2004-04-26 02:28:06 +00:00
}
2006-02-12 07:53:23 +00:00
2008-06-22 20:23:23 +00:00
/**
* Disables showing of database errors .
*
2010-02-22 22:53:54 +00:00
* By default database errors are not shown .
*
2008-06-22 20:23:23 +00:00
* @ since 0.71
2010-02-22 22:53:54 +00:00
* @ see wpdb :: show_errors ()
2008-06-22 20:23:23 +00:00
*
* @ return bool Whether showing of errors was active or not
*/
2004-04-26 02:28:06 +00:00
function hide_errors () {
2007-12-16 21:38:24 +00:00
$show = $this -> show_errors ;
2004-04-26 02:28:06 +00:00
$this -> show_errors = false ;
2007-12-16 21:38:24 +00:00
return $show ;
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2008-06-22 20:23:23 +00:00
/**
* Whether to suppress database errors .
*
2010-02-22 22:53:54 +00:00
* By default database errors are suppressed , with a simple
* call to this function they can be enabled .
*
* @ since 2.5
* @ see wpdb :: hide_errors ()
* @ param bool $suppress Optional . New value . Defaults to true .
* @ return bool Old value
2008-06-22 20:23:23 +00:00
*/
2008-03-12 22:41:43 +00:00
function suppress_errors ( $suppress = true ) {
$errors = $this -> suppress_errors ;
2010-02-22 22:53:54 +00:00
$this -> suppress_errors = ( bool ) $suppress ;
2008-03-12 22:41:43 +00:00
return $errors ;
}
2008-06-22 20:23:23 +00:00
/**
* Kill cached query results .
*
* @ since 0.71
2010-02-22 22:53:54 +00:00
* @ return void
2008-06-22 20:23:23 +00:00
*/
2004-04-26 02:28:06 +00:00
function flush () {
2006-08-11 22:23:03 +00:00
$this -> last_result = array ();
2010-02-22 22:53:54 +00:00
$this -> col_info = null ;
$this -> last_query = null ;
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2010-01-08 19:26:00 +00:00
function db_connect ( $query = " SELECT " ) {
global $db_list , $global_db_list ;
2010-02-22 22:53:54 +00:00
if ( ! is_array ( $db_list ) )
2010-01-08 19:26:00 +00:00
return true ;
2010-01-18 22:21:36 +00:00
if ( $this -> blogs != '' && preg_match ( " /( " . $this -> blogs . " | " . $this -> users . " | " . $this -> usermeta . " | " . $this -> site . " | " . $this -> sitemeta . " | " . $this -> sitecategories . " )/i " , $query ) ) {
2010-01-08 19:26:00 +00:00
$action = 'global' ;
$details = $global_db_list [ mt_rand ( 0 , count ( $global_db_list ) - 1 ) ];
$this -> db_global = $details ;
} elseif ( preg_match ( " /^ \\ s*(alter table|create|insert|delete|update|replace) /i " , $query ) ) {
$action = 'write' ;
$details = $db_list [ 'write' ][ mt_rand ( 0 , count ( $db_list [ 'write' ] ) - 1 ) ];
$this -> db_write = $details ;
} else {
$action = '' ;
$details = $db_list [ 'read' ][ mt_rand ( 0 , count ( $db_list [ 'read' ] ) - 1 ) ];
$this -> db_read = $details ;
}
$dbhname = " dbh " . $action ;
$this -> $dbhname = @ mysql_connect ( $details [ 'db_host' ], $details [ 'db_user' ], $details [ 'db_password' ] );
if ( ! $this -> $dbhname ) {
2010-02-22 22:53:54 +00:00
$this -> bail ( /*WP_I18N_DB_CONNECT_DB*/ "
2010-01-08 19:26:00 +00:00
< h1 > Error establishing a database connection </ h1 >
2010-02-20 02:01:46 +00: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>{$details[' db_host ']}</code>. This could mean your host' s database server is down .</ p >
2010-01-08 19:26:00 +00: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 >
2010-02-22 22:53:54 +00:00
" /*/WP_I18N_DB_CONNECT_DB*/);
2010-01-08 19:26:00 +00:00
}
$this -> select ( $details [ 'db_name' ], $this -> $dbhname );
}
2008-06-22 20:23:23 +00: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 22:53:54 +00:00
* @ param string $query Database query
2009-04-10 21:57:40 +00:00
* @ return int | false Number of rows affected / selected or false on error
2008-06-22 20:23:23 +00:00
*/
2010-02-22 22:53:54 +00:00
function query ( $query ) {
2007-12-21 19:54:46 +00:00
if ( ! $this -> ready )
2007-12-21 19:30:08 +00:00
return false ;
2006-12-07 00:02:03 +00:00
// filter the query, if filters are available
// NOTE: some queries are made before the plugins have been loaded, and thus cannot be filtered with this method
2010-02-22 22:53:54 +00:00
if ( function_exists ( 'apply_filters' ) )
$query = apply_filters ( 'query' , $query );
2006-12-07 00:02:03 +00:00
2010-02-22 22:53:54 +00:00
// initialize return
2004-04-26 02:54:06 +00:00
$return_val = 0 ;
2004-04-26 02:28:06 +00:00
$this -> flush ();
2003-05-28 08:41:04 +00:00
2004-04-26 02:28:06 +00: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 22:53:54 +00:00
if ( defined ( 'SAVEQUERIES' ) && SAVEQUERIES )
2004-08-20 17:52:49 +00:00
$this -> timer_start ();
2010-01-15 22:11:12 +00:00
2010-01-08 19:26:00 +00:00
// use $this->dbh for read ops, and $this->dbhwrite for write ops
// use $this->dbhglobal for gloal table ops
unset ( $dbh );
2010-02-19 01:03:58 +00:00
if ( defined ( 'WP_USE_MULTIPLE_DB' ) && WP_USE_MULTIPLE_DB ) {
2010-01-08 19:26:00 +00:00
if ( $this -> blogs != '' && preg_match ( " /( " . $this -> blogs . " | " . $this -> users . " | " . $this -> usermeta . " | " . $this -> site . " | " . $this -> sitemeta . " | " . $this -> sitecategories . " )/i " , $query ) ) {
if ( false == isset ( $this -> dbhglobal ) ) {
$this -> db_connect ( $query );
}
$dbh =& $this -> dbhglobal ;
$this -> last_db_used = " global " ;
} elseif ( preg_match ( " /^ \\ s*(alter table|create|insert|delete|update|replace) /i " , $query ) ) {
if ( false == isset ( $this -> dbhwrite ) ) {
$this -> db_connect ( $query );
}
$dbh =& $this -> dbhwrite ;
$this -> last_db_used = " write " ;
} else {
$dbh =& $this -> dbh ;
$this -> last_db_used = " read " ;
}
} else {
$dbh =& $this -> dbh ;
$this -> last_db_used = " other/read " ;
}
2006-02-12 07:53:23 +00:00
2010-02-22 22:53:54 +00:00
$this -> result = @ mysql_query ( $query , $dbh );
2004-04-26 02:54:06 +00:00
++ $this -> num_queries ;
2007-02-27 15:24:54 +00:00
2008-06-20 15:17:09 +00:00
if ( defined ( 'SAVEQUERIES' ) && SAVEQUERIES )
2007-11-21 00:14:58 +00:00
$this -> queries [] = array ( $query , $this -> timer_stop (), $this -> get_caller () );
2004-04-26 02:28:06 +00:00
2004-04-26 02:54:06 +00:00
// If there is an error then take note of it..
2010-02-22 22:53:54 +00:00
if ( $this -> last_error = mysql_error ( $dbh ) ) {
2004-04-26 02:54:06 +00:00
$this -> print_error ();
return false ;
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2010-02-22 22:53:54 +00:00
if ( preg_match ( " /^ \\ s*(insert|delete|update|replace|alter) /i " , $query ) ) {
$this -> rows_affected = mysql_affected_rows ( $dbh );
2004-04-26 02:54:06 +00:00
// Take note of the insert_id
2010-02-22 22:53:54 +00:00
if ( preg_match ( " /^ \\ s*(insert|replace) /i " , $query ) ) {
2010-01-08 19:26:00 +00:00
$this -> insert_id = mysql_insert_id ( $dbh );
2004-04-26 02:54:06 +00:00
}
// Return number of rows affected
$return_val = $this -> rows_affected ;
2004-04-26 02:28:06 +00:00
} else {
2004-04-26 02:54:06 +00:00
$i = 0 ;
2010-02-22 22:53:54 +00:00
while ( $i < @ mysql_num_fields ( $this -> result ) ) {
$this -> col_info [ $i ] = @ mysql_fetch_field ( $this -> result );
2004-04-26 02:54:06 +00:00
$i ++ ;
}
$num_rows = 0 ;
2010-02-22 22:53:54 +00:00
while ( $row = @ mysql_fetch_object ( $this -> result ) ) {
2004-04-26 02:54:06 +00:00
$this -> last_result [ $num_rows ] = $row ;
$num_rows ++ ;
}
2003-05-28 08:41:04 +00:00
2010-02-22 22:53:54 +00:00
@ mysql_free_result ( $this -> result );
2003-05-28 08:41:04 +00:00
2004-04-26 02:54:06 +00:00
// Log number of rows the query returned
2010-02-22 22:53:54 +00:00
// and return number of rows selected
2004-04-26 02:54:06 +00:00
$this -> num_rows = $num_rows ;
2010-02-22 22:53:54 +00:00
$return_val = $num_rows ;
2004-04-26 02:54:06 +00:00
}
2003-05-28 08:41:04 +00:00
2004-04-26 02:54:06 +00:00
return $return_val ;
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2007-10-10 22:01:40 +00:00
/**
2009-04-10 21:57:40 +00:00
* Insert a row into a table .
*
* < code >
* wpdb :: insert ( 'table' , array ( 'column' => 'foo' , 'field' => 1337 ), array ( '%s' , '%d' ) )
* </ code >
2008-06-22 20:23:23 +00:00
*
* @ since 2.5 . 0
2009-04-10 21:57:40 +00:00
* @ see wpdb :: prepare ()
2008-06-22 20:23:23 +00:00
*
2009-04-10 21:37:19 +00:00
* @ param string $table table name
2009-04-10 21:57:40 +00: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 ) .
* @ 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 .
* @ return int | false The number of rows inserted , or false on error .
2007-10-10 22:01:40 +00:00
*/
2010-02-22 22:53:54 +00:00
function insert ( $table , $data , $format = null ) {
2009-03-06 00:50:19 +00:00
$formats = $format = ( array ) $format ;
2010-02-22 22:53:54 +00:00
$fields = array_keys ( $data );
2009-03-05 23:47:02 +00:00
$formatted_fields = array ();
2009-03-06 00:50:19 +00:00
foreach ( $fields as $field ) {
2010-02-22 22:53:54 +00:00
if ( ! empty ( $format ) )
$form = ( $form = array_shift ( $formats ) ) ? $form : $format [ 0 ];
elseif ( isset ( $this -> field_types [ $field ] ) )
2009-04-10 21:56:30 +00:00
$form = $this -> field_types [ $field ];
2009-03-06 00:50:19 +00:00
else
$form = '%s' ;
2009-03-05 23:47:02 +00:00
$formatted_fields [] = $form ;
}
2009-04-10 21:37:19 +00:00
$sql = " INSERT INTO ` $table ` (` " . implode ( '`,`' , $fields ) . " `) VALUES (' " . implode ( " ',' " , $formatted_fields ) . " ') " ;
2010-02-22 22:53:54 +00:00
return $this -> query ( $this -> prepare ( $sql , $data ) );
2007-10-10 22:01:40 +00:00
}
2009-04-20 18:18:39 +00:00
2007-10-10 22:01:40 +00:00
/**
2009-04-10 21:57:40 +00:00
* Update a row in the table
*
* < code >
* wpdb :: update ( 'table' , array ( 'column' => 'foo' , 'field' => 1337 ), array ( 'ID' => 1 ), array ( '%s' , '%d' ), array ( '%d' ) )
* </ code >
2008-06-22 20:23:23 +00:00
*
* @ since 2.5 . 0
2009-04-10 21:57:40 +00:00
* @ see wpdb :: prepare ()
2008-06-22 20:23:23 +00:00
*
2009-04-10 21:37:19 +00:00
* @ param string $table table name
2009-04-10 21:57:40 +00: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 . A format is one of '%d' , '%s' ( decimal number , string ) . If omitted , all values in $data will be treated as strings .
* @ 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 .
* @ return int | false The number of rows updated , or false on error .
2007-10-10 22:01:40 +00:00
*/
2010-02-22 22:53:54 +00:00
function update ( $table , $data , $where , $format = null , $where_format = null ) {
if ( ! is_array ( $where ) )
2009-03-05 23:47:02 +00:00
return false ;
$formats = $format = ( array ) $format ;
2007-10-13 01:44:25 +00:00
$bits = $wheres = array ();
2010-02-22 22:53:54 +00:00
foreach ( ( array ) array_keys ( $data ) as $field ) {
if ( ! empty ( $format ) )
$form = ( $form = array_shift ( $formats ) ) ? $form : $format [ 0 ];
2009-04-10 21:56:30 +00:00
elseif ( isset ( $this -> field_types [ $field ]) )
$form = $this -> field_types [ $field ];
2009-03-06 00:50:19 +00:00
else
$form = '%s' ;
$bits [] = " ` $field ` = { $form } " ;
2009-03-05 23:47:02 +00:00
}
2007-10-13 01:44:25 +00:00
2009-03-05 23:47:02 +00:00
$where_formats = $where_format = ( array ) $where_format ;
2010-02-22 22:53:54 +00: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 21:56:30 +00:00
$form = $this -> field_types [ $field ];
2009-03-06 00:50:19 +00:00
else
$form = '%s' ;
2009-04-10 21:37:19 +00:00
$wheres [] = " ` $field ` = { $form } " ;
2009-03-05 23:47:02 +00:00
}
2008-08-09 05:36:14 +00:00
2009-04-10 21:37:19 +00:00
$sql = " UPDATE ` $table ` SET " . implode ( ', ' , $bits ) . ' WHERE ' . implode ( ' AND ' , $wheres );
2010-02-22 22:53:54 +00:00
return $this -> query ( $this -> prepare ( $sql , array_merge ( array_values ( $data ), array_values ( $where ) ) ) );
2007-10-10 22:01:40 +00:00
}
2006-11-30 01:44:33 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve one variable from the database .
*
2009-04-10 21:57:40 +00: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 20:23:23 +00:00
*
* @ since 0.71
*
2010-02-22 22:53:54 +00:00
* @ param string | null $query Optional . SQL query . If null ( default ), uses the result from the previous query .
2009-04-10 21:57:40 +00: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-22 22:53:54 +00:00
* @ return string | null Database query result , or null on failure
2006-11-30 01:44:33 +00:00
*/
2010-02-22 22:53:54 +00:00
function get_var ( $query = null , $x = 0 , $y = 0 ) {
$this -> func_call = " \$ db->get_var( \" $query\ " , $x , $y ) " ;
2004-04-26 02:54:06 +00:00
if ( $query )
2010-02-22 22:53:54 +00:00
$this -> query ( $query );
2003-05-28 08:41:04 +00:00
2004-04-26 02:28:06 +00:00
// Extract var out of cached results based x,y vals
2008-02-02 18:42:09 +00:00
if ( ! empty ( $this -> last_result [ $y ] ) ) {
2010-02-22 22:53:54 +00:00
$values = array_values ( get_object_vars ( $this -> last_result [ $y ] ) );
2003-05-28 08:41:04 +00:00
}
2004-04-26 02:28:06 +00:00
// If there is a value return it else return null
2010-02-22 22:53:54 +00:00
return ( isset ( $values [ $x ] ) && $values [ $x ] !== '' ) ? $values [ $x ] : null ;
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2006-11-30 01:44:33 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve one row from the database .
*
2009-04-10 21:57:40 +00:00
* Executes a SQL query and returns the row from the SQL result .
*
2008-06-22 20:23:23 +00:00
* @ since 0.71
*
2009-04-10 21:57:40 +00:00
* @ param string | null $query SQL 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.
2010-02-22 22:53:54 +00:00
* @ return mixed Database query result in format specifed by $output or null on failure
2006-11-30 01:44:33 +00:00
*/
2010-02-22 22:53:54 +00:00
function get_row ( $query = null , $output = OBJECT , $y = 0 ) {
2004-04-26 02:28:06 +00:00
$this -> func_call = " \$ db->get_row( \" $query\ " , $output , $y ) " ;
2004-04-26 02:54:06 +00:00
if ( $query )
2010-02-22 22:53:54 +00:00
$this -> query ( $query );
2007-08-10 01:33:56 +00:00
else
return null ;
2007-06-14 02:25:30 +00:00
2010-02-22 22:53:54 +00:00
if ( ! isset ( $this -> last_result [ $y ] ) )
2006-09-22 14:40:40 +00:00
return null ;
2003-05-28 08:41:04 +00:00
2004-04-26 02:28:06 +00:00
if ( $output == OBJECT ) {
2004-04-26 02:54:06 +00:00
return $this -> last_result [ $y ] ? $this -> last_result [ $y ] : null ;
} elseif ( $output == ARRAY_A ) {
2010-02-22 22:53:54 +00:00
return $this -> last_result [ $y ] ? get_object_vars ( $this -> last_result [ $y ] ) : null ;
2004-04-26 02:54:06 +00:00
} elseif ( $output == ARRAY_N ) {
2010-02-22 22:53:54 +00:00
return $this -> last_result [ $y ] ? array_values ( get_object_vars ( $this -> last_result [ $y ] ) ) : null ;
2004-04-26 02:54:06 +00:00
} else {
2008-06-23 15:40:43 +00:00
$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*/ );
2003-05-28 08:41:04 +00:00
}
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2006-11-30 01:44:33 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve one column from the database .
*
2009-04-10 21:57:40 +00: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 20:23:23 +00:00
* @ since 0.71
*
2010-02-22 22:53:54 +00:00
* @ param string | null $query Optional . SQL query . If null ( default ), use the result from the previous query .
* @ 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-30 01:44:33 +00:00
*/
2010-02-22 22:53:54 +00:00
function get_col ( $query = null , $x = 0 ) {
2004-04-26 02:54:06 +00:00
if ( $query )
2010-02-22 22:53:54 +00:00
$this -> query ( $query );
2007-08-10 19:30:24 +00:00
2007-08-27 19:44:53 +00:00
$new_array = array ();
// Extract the column values
2010-02-22 22:53:54 +00:00
for ( $i = 0 ; $i < count ( $this -> last_result ); $i ++ ) {
$new_array [ $i ] = $this -> get_var ( null , $x , $i );
2004-04-26 02:28:06 +00:00
}
return $new_array ;
}
2003-05-28 08:41:04 +00:00
2006-11-30 01:44:33 +00:00
/**
2009-04-10 21:57:40 +00: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 20:23:23 +00:00
*
* @ since 0.71
*
2009-04-10 21:57:40 +00:00
* @ param string $query SQL query .
* @ param string $output ( optional ) ane 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 .
2008-06-22 20:23:23 +00:00
* @ return mixed Database query results
2006-11-30 01:44:33 +00:00
*/
2010-02-22 22:53:54 +00:00
function get_results ( $query = null , $output = OBJECT ) {
2004-04-26 02:28:06 +00:00
$this -> func_call = " \$ db->get_results( \" $query\ " , $output ) " ;
2003-05-28 08:41:04 +00:00
2004-04-26 02:54:06 +00:00
if ( $query )
2010-02-22 22:53:54 +00:00
$this -> query ( $query );
2007-08-10 01:33:56 +00:00
else
return null ;
2003-05-28 08:41:04 +00:00
2010-02-15 10:00:39 +00:00
$new_array = array ();
2004-04-26 02:28:06 +00:00
if ( $output == OBJECT ) {
2008-02-25 22:00:27 +00:00
// Return an integer-keyed array of row objects
2004-04-26 02:28:06 +00:00
return $this -> last_result ;
2008-02-25 22:00:27 +00:00
} elseif ( $output == OBJECT_K ) {
// Return an array of row objects with keys from column 1
// (Duplicates are discarded)
foreach ( $this -> last_result as $row ) {
$key = array_shift ( get_object_vars ( $row ) );
if ( ! isset ( $new_array [ $key ] ) )
$new_array [ $key ] = $row ;
}
return $new_array ;
2004-04-26 02:28:06 +00:00
} elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
2008-02-25 22:00:27 +00:00
// Return an integer-keyed array of...
2004-04-26 02:28:06 +00:00
if ( $this -> last_result ) {
2004-04-26 02:54:06 +00:00
$i = 0 ;
2008-08-06 20:31:54 +00:00
foreach ( ( array ) $this -> last_result as $row ) {
2004-04-26 02:28:06 +00:00
if ( $output == ARRAY_N ) {
2008-02-25 22:00:27 +00:00
// ...integer-keyed row arrays
$new_array [ $i ] = array_values ( get_object_vars ( $row ) );
} else {
// ...column name-keyed row arrays
$new_array [ $i ] = get_object_vars ( $row );
2003-05-28 08:41:04 +00:00
}
2008-02-25 22:00:27 +00:00
++ $i ;
2003-05-28 08:41:04 +00:00
}
2004-04-26 02:28:06 +00:00
return $new_array ;
2003-05-28 08:41:04 +00:00
}
}
2004-04-26 02:28:06 +00:00
}
2003-05-28 08:41:04 +00:00
2006-11-30 01:44:33 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve column metadata from the last query .
*
* @ since 0.71
*
2010-02-22 22:53:54 +00: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 20:23:23 +00:00
* @ return mixed Column Results
2006-11-30 01:44:33 +00:00
*/
2010-02-22 22:53:54 +00:00
function get_col_info ( $info_type = 'name' , $col_offset = - 1 ) {
2004-04-26 02:28:06 +00:00
if ( $this -> col_info ) {
if ( $col_offset == - 1 ) {
2010-02-22 22:53:54 +00:00
$i = 0 ;
2010-02-15 10:00:39 +00:00
$new_array = array ();
2008-08-06 20:31:54 +00:00
foreach ( ( array ) $this -> col_info as $col ) {
2004-04-26 02:28:06 +00:00
$new_array [ $i ] = $col -> { $info_type };
$i ++ ;
2003-05-28 08:41:04 +00:00
}
2004-04-26 02:28:06 +00:00
return $new_array ;
} else {
return $this -> col_info [ $col_offset ] -> { $info_type };
2003-05-28 08:41:04 +00:00
}
}
}
2004-07-23 01:35:56 +00:00
2006-11-30 01:44:33 +00:00
/**
2008-06-22 20:23:23 +00:00
* Starts the timer , for debugging purposes .
*
* @ since 1.5 . 0
*
2009-04-10 21:57:40 +00:00
* @ return true
2006-11-30 01:44:33 +00:00
*/
2004-08-20 17:52:49 +00:00
function timer_start () {
2010-02-22 22:53:54 +00:00
$mtime = explode ( ' ' , microtime () );
2004-08-20 17:52:49 +00:00
$this -> time_start = $mtime [ 1 ] + $mtime [ 0 ];
return true ;
2004-07-23 01:35:56 +00:00
}
2006-02-12 07:53:23 +00:00
2006-11-30 01:44:33 +00:00
/**
2008-06-22 20:23:23 +00:00
* Stops the debugging timer .
*
* @ since 1.5 . 0
*
* @ return int Total time spent on the query , in milliseconds
2006-11-30 01:44:33 +00:00
*/
function timer_stop () {
2010-02-22 22:53:54 +00:00
$mtime = explode ( ' ' , microtime () );
$time_end = $mtime [ 1 ] + $mtime [ 0 ];
2004-08-20 17:52:49 +00:00
$time_total = $time_end - $this -> time_start ;
2004-08-20 17:56:51 +00:00
return $time_total ;
2004-07-23 01:35:56 +00:00
}
2006-11-30 01:44:33 +00:00
/**
2009-04-10 21:57:40 +00:00
* Wraps errors in a nice header and footer and dies .
*
* Will not die if wpdb :: $show_errors is true
2008-06-22 20:23:23 +00:00
*
* @ since 1.5 . 0
*
2009-08-21 17:00:53 +00:00
* @ param string $message The Error message
* @ param string $error_code ( optional ) A Computer readable string to identify the error .
2009-04-10 21:57:40 +00:00
* @ return false | void
2006-11-30 01:44:33 +00:00
*/
2010-02-22 22:53:54 +00:00
function bail ( $message , $error_code = '500' ) {
2007-12-20 02:10:09 +00:00
if ( ! $this -> show_errors ) {
2010-02-22 22:53:54 +00:00
if ( class_exists ( 'WP_Error' ) )
2009-08-21 17:00:53 +00:00
$this -> error = new WP_Error ( $error_code , $message );
2007-12-20 02:10:09 +00:00
else
$this -> error = $message ;
2006-07-10 05:29:10 +00:00
return false ;
2007-12-20 02:10:09 +00:00
}
2007-09-13 06:23:23 +00:00
wp_die ( $message );
2004-07-23 01:35:56 +00:00
}
2007-12-20 02:10:09 +00:00
2007-10-06 08:40:54 +00:00
/**
2009-04-10 21:57:40 +00:00
* Whether or not MySQL database is at least the required minimum version .
2008-06-22 20:23:23 +00:00
*
* @ since 2.5 . 0
* @ uses $wp_version
2010-02-22 22:53:54 +00:00
* @ uses $required_mysql_version
2008-06-22 20:23:23 +00:00
*
* @ return WP_Error
2007-10-06 08:40:54 +00:00
*/
2010-02-15 10:00:39 +00:00
function check_database_version () {
2009-12-22 11:49:22 +00: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 22:53:54 +00: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 08:40:54 +00:00
}
/**
2009-04-10 21:57:40 +00:00
* Whether of not the database supports collation .
2008-06-22 20:23:23 +00: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 08:40:54 +00:00
*/
2009-08-21 17:00:53 +00:00
function supports_collation () {
2008-08-26 23:57:48 +00:00
return $this -> has_cap ( 'collation' );
2007-10-06 08:40:54 +00:00
}
2007-11-21 00:14:58 +00:00
2008-08-26 19:18:58 +00:00
/**
2010-02-22 22:53:54 +00:00
* Determine if a database supports a particular feature
*
* @ since 2.7
* @ see wpdb :: db_version ()
*
2008-08-26 23:57:48 +00:00
* @ param string $db_cap the feature
2010-02-22 22:53:54 +00:00
* @ param false | string | resource $dbh_or_table . Not implemented .
* Which database to test . False = the currently selected database , string = the database containing the specified table , resource = the database corresponding to the specified mysql resource .
2008-08-26 23:57:48 +00:00
* @ return bool
2008-08-26 19:18:58 +00:00
*/
2008-08-26 23:57:48 +00:00
function has_cap ( $db_cap ) {
$version = $this -> db_version ();
2010-02-22 22:53:54 +00: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' , '>=' );
};
2008-08-26 23:57:48 +00:00
return false ;
2008-08-26 19:18:58 +00:00
}
2007-11-21 00:14:58 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the name of the function that called wpdb .
*
2010-02-03 21:38:09 +00:00
* Searches up the list of functions until it reaches
2008-06-22 20:23:23 +00: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-21 00:14:58 +00:00
*/
function get_caller () {
$bt = debug_backtrace ();
2008-11-25 23:45:02 +00:00
$caller = array ();
2007-11-21 00:14:58 +00:00
2008-11-25 22:17:55 +00:00
$bt = array_reverse ( $bt );
foreach ( ( array ) $bt as $call ) {
2010-02-17 12:13:34 +00:00
if ( isset ( $call [ 'class' ] ) && __CLASS__ == $call [ 'class' ] )
2007-11-21 00:14:58 +00:00
continue ;
2008-11-25 22:17:55 +00:00
$function = $call [ 'function' ];
if ( isset ( $call [ 'class' ] ) )
$function = $call [ 'class' ] . " -> $function " ;
$caller [] = $function ;
2007-11-21 00:14:58 +00:00
}
2008-11-25 22:17:55 +00:00
$caller = join ( ', ' , $caller );
2007-11-21 00:14:58 +00:00
return $caller ;
}
2008-08-26 22:30:56 +00:00
/**
* The database version number
2010-02-22 22:53:54 +00:00
* @ param false | string | resource $dbh_or_table . Not implemented .
* Which database to test . False = the currently selected database , string = the database containing the specified table , resource = the database corresponding to the specified mysql resource .
2008-08-26 22:30:56 +00:00
* @ return false | string false on failure , version number on success
*/
function db_version () {
2010-02-22 22:53:54 +00:00
return preg_replace ( '/[^0-9.].*/' , '' , mysql_get_server_info ( $this -> dbh ) );
2008-08-26 22:30:56 +00:00
}
2004-04-26 02:28:06 +00:00
}
2008-06-22 20:23:23 +00:00
if ( ! isset ( $wpdb ) ) {
/**
2008-10-02 16:45:28 +00:00
* WordPress Database Object , if it isn ' t set already in wp - content / db . php
2008-06-22 20:23:23 +00:00
* @ global object $wpdb Creates a new wpdb object based on wp - config . php Constants for the database
* @ since 0.71
*/
2006-09-01 18:44:13 +00:00
$wpdb = new wpdb ( DB_USER , DB_PASSWORD , DB_NAME , DB_HOST );
2008-06-22 20:23:23 +00:00
}
2007-10-06 08:40:54 +00:00
?>