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
*/
2004-04-26 02:54:06 +00:00
define ( 'EZSQL_VERSION' , 'WP1.25' );
2008-06-22 20:23:23 +00:00
/**
* @ since 0.71
*/
2004-04-26 02:54:06 +00:00
define ( 'OBJECT' , 'OBJECT' , true );
2008-06-22 20:23:23 +00:00
/**
* @ since { @ internal Version Unknown }}
*/
2008-02-25 22:00:27 +00:00
define ( 'OBJECT_K' , 'OBJECT_K' , false );
2008-06-22 20:23:23 +00:00
/**
* @ since 0.71
*/
2004-04-26 02:54:06 +00:00
define ( 'ARRAY_A' , 'ARRAY_A' , false );
2008-06-22 20:23:23 +00:00
/**
* @ since 0.71
*/
2004-04-26 02:54:06 +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
* by setting the $wpdb global variable in wp - content / wpdb . php
* 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
* @ since { @ internal Version Unknown }}
* @ 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 .
*
* @ since { @ internal Version Unknown }}
* @ 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
/**
* 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
/**
* 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 ;
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 Categories table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 08:22:18 +00:00
var $categories ;
2008-06-22 20:23:23 +00:00
/**
* WordPress Post to Category table
*
* @ since 1.5 . 0
* @ access public
* @ var string
*/
2004-05-24 08:22:18 +00:00
var $post2cat ;
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
/**
* 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
/**
* List of WordPress tables
*
* @ since { @ internal Version Unknown }}
* @ access private
* @ var array
*/
2007-10-31 03:59:18 +00:00
var $tables = array ( 'users' , 'usermeta' , 'posts' , 'categories' , 'post2cat' , 'comments' , 'links' , 'link2cat' , 'options' ,
'postmeta' , 'terms' , 'term_taxonomy' , 'term_relationships' );
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 ;
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
*/
2004-04-26 02:28:06 +00:00
function wpdb ( $dbuser , $dbpassword , $dbname , $dbhost ) {
2007-01-06 23:36:51 +00:00
return $this -> __construct ( $dbuser , $dbpassword , $dbname , $dbhost );
}
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
*/
2007-01-06 23:36:51 +00:00
function __construct ( $dbuser , $dbpassword , $dbname , $dbhost ) {
register_shutdown_function ( array ( & $this , " __destruct " ));
2007-12-22 17:45:30 +00:00
if ( defined ( 'WP_DEBUG' ) and WP_DEBUG == true )
$this -> show_errors ();
2007-02-02 00:04:35 +00:00
if ( defined ( 'DB_CHARSET' ) )
$this -> charset = DB_CHARSET ;
if ( defined ( 'DB_COLLATE' ) )
$this -> collate = DB_COLLATE ;
2008-01-31 22:09:17 +00:00
$this -> dbh = @ mysql_connect ( $dbhost , $dbuser , $dbpassword , true );
2004-04-26 02:54:06 +00:00
if ( ! $this -> dbh ) {
2008-06-23 15:40:43 +00:00
$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 >
2008-06-23 15:40:43 +00:00
" /*/WP_I18N_DB_CONN_ERROR*/, $dbhost ));
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 ;
2008-03-30 17:56:27 +00:00
if ( $this -> supports_collation () ) {
$collation_query = '' ;
if ( ! empty ( $this -> charset ) ) {
$collation_query = " SET NAMES ' { $this -> charset } ' " ;
if ( ! empty ( $this -> collate ) )
$collation_query .= " COLLATE ' { $this -> collate } ' " ;
}
if ( ! empty ( $collation_query ) )
$this -> query ( $collation_query );
}
2004-04-26 02:28:06 +00:00
$this -> select ( $dbname );
}
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
*
* @ return bool Always true
*/
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 .
*
* Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
* override the WordPress users and usersmeta tables .
*
* @ since 2.5 . 0
*
* @ param string $prefix Alphanumeric name for the new prefix .
* @ return string Old prefix
*/
2007-10-31 03:59:18 +00:00
function set_prefix ( $prefix ) {
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
$old_prefix = $this -> prefix ;
$this -> prefix = $prefix ;
2008-08-06 20:31:54 +00:00
foreach ( ( array ) $this -> tables as $table )
2007-10-31 03:59:18 +00:00
$this -> $table = $this -> prefix . $table ;
if ( defined ( 'CUSTOM_USER_TABLE' ) )
$this -> users = CUSTOM_USER_TABLE ;
if ( defined ( 'CUSTOM_USER_META_TABLE' ) )
$this -> usermeta = CUSTOM_USER_META_TABLE ;
return $old_prefix ;
}
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
*/
2004-04-26 02:28:06 +00:00
function select ( $db ) {
2004-08-20 17:52:49 +00:00
if ( !@ mysql_select_db ( $db , $this -> dbh )) {
2007-12-22 06:24:48 +00:00
$this -> ready = false ;
2008-06-23 15:40:43 +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 >
2004-07-23 01:35:56 +00:00
< li > On some systems the name of your database is prefixed with your username , so it would be like username_wordpress . Could that be the problem ? </ li >
</ ul >
2008-06-23 15:40:43 +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 , DB_USER ));
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
2006-11-30 01:44:33 +00:00
/**
* Escapes content for insertion into the database , for security
*
2008-06-22 20:23:23 +00:00
* @ since 0.71
*
2006-11-30 01:44:33 +00:00
* @ param string $string
* @ return string query safe string
*/
2005-07-04 06:27:04 +00:00
function escape ( $string ) {
2007-12-09 11:28:57 +00:00
return addslashes ( $string );
// Disable rest for now, causing problems
/*
2005-07-02 23:31:43 +00:00
if ( ! $this -> dbh || version_compare ( phpversion (), '4.3.0' ) == '-1' )
return mysql_escape_string ( $string );
else
return mysql_real_escape_string ( $string , $this -> dbh );
2007-12-09 11:28:57 +00:00
*/
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
*
2007-07-04 16:18:57 +00:00
* @ param string $s
*/
function escape_by_ref ( & $s ) {
$s = $this -> escape ( $s );
}
/**
2008-06-22 20:23:23 +00:00
* Prepares a SQL query for safe use , using sprintf () syntax .
*
* @ link http :// php . net / sprintf See for syntax to use for query string .
* @ since 2.3 . 0
*
* @ param null | string $args If string , first parameter must be query statement
* @ param mixed $args , ... If additional parameters , they will be set inserted into the query .
* @ return null | string Sanitized query string
2007-07-04 16:18:57 +00:00
*/
2008-06-22 20:23:23 +00:00
function prepare ( $args = null ) {
if ( is_null ( $args ) )
2007-07-04 16:18:57 +00:00
return ;
$args = func_get_args ();
$query = array_shift ( $args );
2007-07-09 17:55:32 +00:00
$query = str_replace ( " '%s' " , '%s' , $query ); // in case someone mistakenly already singlequoted it
$query = str_replace ( '"%s"' , '%s' , $query ); // doublequote unquoting
2007-07-05 17:32:46 +00:00
$query = str_replace ( '%s' , " '%s' " , $query ); // quote the strings
2007-07-04 16:18:57 +00:00
array_walk ( $args , array ( & $this , 'escape_by_ref' ));
2007-07-05 17:32:46 +00:00
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 .
*/
2004-04-26 02:28:06 +00:00
function print_error ( $str = '' ) {
global $EZSQL_ERROR ;
2008-03-12 22:41:43 +00:00
2007-01-16 02:32:42 +00:00
if ( ! $str ) $str = mysql_error ( $this -> dbh );
2008-06-22 20:23:23 +00:00
$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-03-20 19:16:38 +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
$str = htmlspecialchars ( $str , ENT_QUOTES );
$query = htmlspecialchars ( $this -> last_query , ENT_QUOTES );
// If there is an error then take note of it
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
*
* @ 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 .
*
* @ since 0.71
*
* @ 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 .
*
* @ param unknown_type $suppress
* @ return unknown
*/
2008-03-12 22:41:43 +00:00
function suppress_errors ( $suppress = true ) {
$errors = $this -> suppress_errors ;
$this -> suppress_errors = $suppress ;
return $errors ;
}
2008-06-22 20:23:23 +00:00
/**
* Kill cached query results .
*
* @ since 0.71
*/
2004-04-26 02:28:06 +00:00
function flush () {
2006-08-11 22:23:03 +00:00
$this -> last_result = array ();
2004-04-26 02:28:06 +00:00
$this -> col_info = null ;
$this -> last_query = null ;
}
2003-05-28 08:41:04 +00:00
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
*
* @ param string $query
* @ return unknown
*/
2004-04-26 02:28:06 +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
if ( function_exists ( 'apply_filters' ) )
$query = apply_filters ( 'query' , $query );
2004-04-26 02:54:06 +00:00
// initialise return
$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 ;
// Perform the query via std mysql_query function..
2008-06-20 15:17:09 +00:00
if ( defined ( 'SAVEQUERIES' ) && SAVEQUERIES )
2004-08-20 17:52:49 +00:00
$this -> timer_start ();
2006-02-12 07:53:23 +00:00
2004-08-20 17:52:49 +00:00
$this -> result = @ mysql_query ( $query , $this -> 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..
2008-03-20 23:34:32 +00:00
if ( $this -> last_error = mysql_error ( $this -> 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
2004-04-26 02:54:06 +00:00
if ( preg_match ( " /^ \\ s*(insert|delete|update|replace) /i " , $query ) ) {
2007-04-06 17:22:53 +00:00
$this -> rows_affected = mysql_affected_rows ( $this -> dbh );
2004-04-26 02:54:06 +00:00
// Take note of the insert_id
if ( preg_match ( " /^ \\ s*(insert|replace) /i " , $query ) ) {
2006-02-12 07:53:23 +00:00
$this -> insert_id = mysql_insert_id ( $this -> 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 ;
while ( $i < @ mysql_num_fields ( $this -> result )) {
$this -> col_info [ $i ] = @ mysql_fetch_field ( $this -> result );
$i ++ ;
}
$num_rows = 0 ;
while ( $row = @ mysql_fetch_object ( $this -> result ) ) {
$this -> last_result [ $num_rows ] = $row ;
$num_rows ++ ;
}
2003-05-28 08:41:04 +00:00
2004-04-26 02:54:06 +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
$this -> num_rows = $num_rows ;
2006-02-12 07:53:23 +00:00
2004-04-26 02:54:06 +00:00
// Return number of rows selected
$return_val = $this -> num_rows ;
}
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
/**
2008-06-22 20:23:23 +00:00
* Insert an array of data into a table .
*
* @ since 2.5 . 0
*
2007-10-10 22:01:40 +00:00
* @ param string $table WARNING : not sanitized !
2008-06-22 20:23:23 +00:00
* @ param array $data Should not already be SQL - escaped
* @ return mixed Results of $this -> query ()
2007-10-10 22:01:40 +00:00
*/
2007-10-13 00:54:26 +00:00
function insert ( $table , $data ) {
2007-10-10 22:01:40 +00:00
$data = add_magic_quotes ( $data );
$fields = array_keys ( $data );
return $this -> query ( " INSERT INTO $table (` " . implode ( '`,`' , $fields ) . " `) VALUES (' " . implode ( " ',' " , $data ) . " ') " );
}
/**
2008-06-22 20:23:23 +00:00
* Update a row in the table with an array of data .
*
* @ since 2.5 . 0
*
2007-10-10 22:01:40 +00:00
* @ param string $table WARNING : not sanitized !
2008-06-22 20:23:23 +00:00
* @ param array $data Should not already be SQL - escaped
* @ param array $where A named array of WHERE column => value relationships . Multiple member pairs will be joined with ANDs . WARNING : the column names are not currently sanitized !
* @ return mixed Results of $this -> query ()
2007-10-10 22:01:40 +00:00
*/
2007-10-13 02:36:38 +00:00
function update ( $table , $data , $where ){
2007-10-10 22:01:40 +00:00
$data = add_magic_quotes ( $data );
2007-10-13 01:44:25 +00:00
$bits = $wheres = array ();
2008-08-06 20:31:54 +00:00
foreach ( ( array ) array_keys ( $data ) as $k )
2007-10-13 01:44:25 +00:00
$bits [] = " ` $k ` = ' $data[$k] ' " ;
2007-10-13 02:36:38 +00:00
if ( is_array ( $where ) )
foreach ( $where as $c => $v )
2007-10-13 01:44:25 +00:00
$wheres [] = " $c = ' " . $this -> escape ( $v ) . " ' " ;
else
return false ;
2008-07-11 01:49:06 +00:00
return $this -> query ( " UPDATE $table SET " . implode ( ', ' , $bits ) . ' WHERE ' . implode ( ' AND ' , $wheres ) );
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 .
*
* This combines the functionality of wpdb :: get_row () and wpdb :: get_col (),
* so both the column and row can be picked .
*
* It is possible to use this function without executing more queries . If
* you already made a query , you can set the $query to 'null' value and just
* retrieve either the column and row of the last query result .
*
* @ since 0.71
*
* @ param string $query Can be null as well , for caching
* @ param int $x Column num to return
* @ param int $y Row num to return
* @ return mixed Database query results
2006-11-30 01:44:33 +00:00
*/
2004-04-26 02:54:06 +00:00
function get_var ( $query = null , $x = 0 , $y = 0 ) {
2004-04-26 02:28:06 +00:00
$this -> func_call = " \$ db->get_var( \" $query\ " , $x , $y ) " ;
2004-04-26 02:54:06 +00:00
if ( $query )
2004-04-26 02:28:06 +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 ] ) ) {
2004-04-26 02:28:06 +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
return ( isset ( $values [ $x ]) && $values [ $x ] !== '' ) ? $values [ $x ] : null ;
}
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 .
*
* @ since 0.71
*
* @ param string $query SQL query
2006-11-30 01:44:33 +00:00
* @ param string $output ARRAY_A | ARRAY_N | OBJECT
2008-06-22 20:23:23 +00:00
* @ param int $y Row num to return
* @ return mixed Database query results
2006-11-30 01:44:33 +00:00
*/
2004-04-26 02:54:06 +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 )
2004-04-26 02:28:06 +00:00
$this -> query ( $query );
2007-08-10 01:33:56 +00:00
else
return null ;
2007-06-14 02:25:30 +00:00
2006-09-22 14:40:40 +00:00
if ( ! isset ( $this -> last_result [ $y ]) )
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 ) {
return $this -> last_result [ $y ] ? get_object_vars ( $this -> last_result [ $y ]) : null ;
} elseif ( $output == ARRAY_N ) {
return $this -> last_result [ $y ] ? array_values ( get_object_vars ( $this -> last_result [ $y ])) : null ;
} 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 .
*
* @ since 0.71
*
* @ param string $query Can be null as well , for caching
* @ param int $x Col num to return . Starts from 0.
* @ return array Column results
2006-11-30 01:44:33 +00:00
*/
2004-04-26 02:54:06 +00:00
function get_col ( $query = null , $x = 0 ) {
if ( $query )
2004-04-26 02:28:06 +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
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
/**
2008-06-22 20:23:23 +00:00
* Retrieve an entire result set from the database .
*
* @ since 0.71
*
* @ param string | null $query Can also be null to pull from the cache
2008-02-25 22:00:27 +00:00
* @ param string $output ARRAY_A | ARRAY_N | OBJECT_K | OBJECT
2008-06-22 20:23:23 +00:00
* @ return mixed Database query results
2006-11-30 01:44:33 +00:00
*/
2004-04-26 02:54:06 +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 )
2004-04-26 02:28:06 +00:00
$this -> query ( $query );
2007-08-10 01:33:56 +00:00
else
return null ;
2003-05-28 08:41:04 +00:00
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
*
2006-11-30 01:44:33 +00:00
* @ param string $info_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 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
*/
2004-04-26 02:54:06 +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 ) {
2004-04-26 02:54:06 +00:00
$i = 0 ;
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
*
* @ return bool Always returns true
2006-11-30 01:44:33 +00:00
*/
2004-08-20 17:52:49 +00:00
function timer_start () {
$mtime = microtime ();
$mtime = explode ( ' ' , $mtime );
$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 () {
2004-08-20 17:52:49 +00:00
$mtime = microtime ();
$mtime = explode ( ' ' , $mtime );
$time_end = $mtime [ 1 ] + $mtime [ 0 ];
$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
/**
* Wraps fatal errors in a nice header and footer and dies .
2008-06-22 20:23:23 +00:00
*
* @ since 1.5 . 0
*
2006-11-30 01:44:33 +00:00
* @ param string $message
2008-06-22 20:23:23 +00:00
* @ return unknown
2006-11-30 01:44:33 +00:00
*/
2008-06-22 20:23:23 +00:00
function bail ( $message ) {
2007-12-20 02:10:09 +00:00
if ( ! $this -> show_errors ) {
if ( class_exists ( 'WP_Error' ) )
$this -> error = new WP_Error ( '500' , $message );
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
/**
2008-06-22 20:23:23 +00:00
* Whether or not MySQL database is minimal required version .
*
* @ since 2.5 . 0
* @ uses $wp_version
*
* @ return WP_Error
2007-10-06 08:40:54 +00:00
*/
function check_database_version ()
{
global $wp_version ;
// Make sure the server has MySQL 4.0
2008-01-31 22:09:17 +00:00
$mysql_version = preg_replace ( '|[^0-9\.]|' , '' , @ mysql_get_server_info ( $this -> dbh ));
2007-10-06 08:40:54 +00:00
if ( version_compare ( $mysql_version , '4.0.0' , '<' ) )
return new WP_Error ( 'database_version' , sprintf ( __ ( '<strong>ERROR</strong>: WordPress %s requires MySQL 4.0.0 or higher' ), $wp_version ));
}
/**
2008-06-22 20:23:23 +00:00
* Whether of not the database version supports collation .
*
* 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
*/
function supports_collation ()
{
2008-01-31 22:09:17 +00:00
return ( version_compare ( mysql_get_server_info ( $this -> dbh ), '4.1.0' , '>=' ) );
2007-10-06 08:40:54 +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 .
*
* Requires PHP 4.3 and searches up the list of functions until it reaches
* 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 () {
// requires PHP 4.3+
if ( ! is_callable ( 'debug_backtrace' ) )
return '' ;
$bt = debug_backtrace ();
$caller = '' ;
2008-08-06 20:31:54 +00:00
foreach ( ( array ) $bt as $trace ) {
2007-11-21 00:14:58 +00:00
if ( @ $trace [ 'class' ] == __CLASS__ )
continue ;
elseif ( strtolower ( @ $trace [ 'function' ]) == 'call_user_func_array' )
continue ;
elseif ( strtolower ( @ $trace [ 'function' ]) == 'apply_filters' )
continue ;
elseif ( strtolower ( @ $trace [ 'function' ]) == 'do_action' )
continue ;
2008-02-05 06:47:27 +00:00
2007-11-21 00:14:58 +00:00
$caller = $trace [ 'function' ];
break ;
}
return $caller ;
}
2004-04-26 02:28:06 +00:00
}
2008-06-22 20:23:23 +00:00
if ( ! isset ( $wpdb ) ) {
/**
* WordPress Database Object , if it isn ' t set already in wp - content / wpdb . php
* @ 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
?>