5 * Original code from {@link http://php.justinvincent.com Justin Vincent (justin@visunet.ie)}
15 define('EZSQL_VERSION', 'WP1.25');
20 define('OBJECT', 'OBJECT', true);
23 * @since {@internal Version Unknown}}
25 define('OBJECT_K', 'OBJECT_K', false);
30 define('ARRAY_A', 'ARRAY_A', false);
35 define('ARRAY_N', 'ARRAY_N', false);
38 * WordPress Database Access Abstraction Object
40 * It is possible to replace this class with your own
41 * by setting the $wpdb global variable in wp-content/wpdb.php
42 * file with your class. You can name it wpdb also, since
43 * this file will not be included, if the other file is
46 * @link http://codex.wordpress.org/Function_Reference/wpdb_Class
49 * @subpackage Database
56 * Whether to show SQL/DB errors
62 var $show_errors = false;
65 * Whether to suppress errors during the DB bootstrapping.
68 * @since {@internal Version Unknown}}
71 var $suppress_errors = false;
74 * The last error during query.
76 * @since {@internal Version Unknown}}
82 * Amount of queries made
91 * Saved result of the last query made
100 * Saved info on the table column
109 * Saved queries that were executed
118 * WordPress table prefix
120 * You can set this to have multiple WordPress installations
121 * in a single database. The second reason is for possible
122 * security precautions.
131 * Whether the database queries are ready to start executing.
140 * WordPress Posts table
149 * WordPress Users table
158 * WordPress Categories table
167 * WordPress Post to Category table
176 * WordPress Comments table
185 * WordPress Links table
194 * WordPress Options table
203 * WordPress Post Metadata table
205 * @since {@internal Version Unknown}}
212 * WordPress User Metadata table
221 * WordPress Terms table
230 * WordPress Term Taxonomy table
239 * WordPress Term Relationships table
245 var $term_relationships;
248 * List of WordPress tables
250 * @since {@internal Version Unknown}}
254 var $tables = array('users', 'usermeta', 'posts', 'categories', 'post2cat', 'comments', 'links', 'link2cat', 'options',
255 'postmeta', 'terms', 'term_taxonomy', 'term_relationships');
258 * Database table columns charset
267 * Database table columns collate
276 * Connects to the database server and selects a database
278 * PHP4 compatibility layer for calling the PHP5 constructor.
280 * @uses wpdb::__construct() Passes parameters and returns result
283 * @param string $dbuser MySQL database user
284 * @param string $dbpassword MySQL database password
285 * @param string $dbname MySQL database name
286 * @param string $dbhost MySQL database host
288 function wpdb($dbuser, $dbpassword, $dbname, $dbhost) {
289 return $this->__construct($dbuser, $dbpassword, $dbname, $dbhost);
293 * Connects to the database server and selects a database
295 * PHP5 style constructor for compatibility with PHP5. Does
296 * the actual setting up of the class properties and connection
301 * @param string $dbuser MySQL database user
302 * @param string $dbpassword MySQL database password
303 * @param string $dbname MySQL database name
304 * @param string $dbhost MySQL database host
306 function __construct($dbuser, $dbpassword, $dbname, $dbhost) {
307 register_shutdown_function(array(&$this, "__destruct"));
309 if ( defined('WP_DEBUG') and WP_DEBUG == true )
310 $this->show_errors();
312 if ( defined('DB_CHARSET') )
313 $this->charset = DB_CHARSET;
315 if ( defined('DB_COLLATE') )
316 $this->collate = DB_COLLATE;
318 $this->dbh = @mysql_connect($dbhost, $dbuser, $dbpassword, true);
320 $this->bail(sprintf(/*WP_I18N_DB_CONN_ERROR*/"
321 <h1>Error establishing a database connection</h1>
322 <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>
324 <li>Are you sure you have the correct username and password?</li>
325 <li>Are you sure that you have typed the correct hostname?</li>
326 <li>Are you sure that the database server is running?</li>
328 <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>
329 "/*/WP_I18N_DB_CONN_ERROR*/, $dbhost));
335 if ( $this->supports_collation() ) {
336 $collation_query = '';
337 if ( !empty($this->charset) ) {
338 $collation_query = "SET NAMES '{$this->charset}'";
339 if (!empty($this->collate) )
340 $collation_query .= " COLLATE '{$this->collate}'";
343 if ( !empty($collation_query) )
344 $this->query($collation_query);
348 $this->select($dbname);
352 * PHP5 style destructor and will run when database object is destroyed.
356 * @return bool Always true
358 function __destruct() {
363 * Sets the table prefix for the WordPress tables.
365 * Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
366 * override the WordPress users and usersmeta tables.
370 * @param string $prefix Alphanumeric name for the new prefix.
371 * @return string Old prefix
373 function set_prefix($prefix) {
375 if ( preg_match('|[^a-z0-9_]|i', $prefix) )
376 return new WP_Error('invalid_db_prefix', /*WP_I18N_DB_BAD_PREFIX*/'Invalid database prefix'/*/WP_I18N_DB_BAD_PREFIX*/);
378 $old_prefix = $this->prefix;
379 $this->prefix = $prefix;
381 foreach ( $this->tables as $table )
382 $this->$table = $this->prefix . $table;
384 if ( defined('CUSTOM_USER_TABLE') )
385 $this->users = CUSTOM_USER_TABLE;
387 if ( defined('CUSTOM_USER_META_TABLE') )
388 $this->usermeta = CUSTOM_USER_META_TABLE;
394 * Selects a database using the current database connection.
396 * The database name will be changed based on the current database
397 * connection. On failure, the execution will bail and display an DB error.
401 * @param string $db MySQL database name
402 * @return null Always null.
404 function select($db) {
405 if (!@mysql_select_db($db, $this->dbh)) {
406 $this->ready = false;
407 $this->bail(sprintf(/*WP_I18N_DB_SELECT_DB*/'
408 <h1>Can’t select database</h1>
409 <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>
411 <li>Are you sure it exists?</li>
412 <li>Does the user <code>%2$s</code> have permission to use the <code>%1$s</code> database?</li>
413 <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>
415 <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));
421 * Escapes content for insertion into the database, for security
425 * @param string $string
426 * @return string query safe string
428 function escape($string) {
429 return addslashes( $string );
430 // Disable rest for now, causing problems
432 if( !$this->dbh || version_compare( phpversion(), '4.3.0' ) == '-1' )
433 return mysql_escape_string( $string );
435 return mysql_real_escape_string( $string, $this->dbh );
440 * Escapes content by reference for insertion into the database, for security
446 function escape_by_ref(&$s) {
447 $s = $this->escape($s);
451 * Prepares a SQL query for safe use, using sprintf() syntax.
453 * @link http://php.net/sprintf See for syntax to use for query string.
456 * @param null|string $args If string, first parameter must be query statement
457 * @param mixed $args,... If additional parameters, they will be set inserted into the query.
458 * @return null|string Sanitized query string
460 function prepare($args=null) {
461 if ( is_null( $args ) )
463 $args = func_get_args();
464 $query = array_shift($args);
465 $query = str_replace("'%s'", '%s', $query); // in case someone mistakenly already singlequoted it
466 $query = str_replace('"%s"', '%s', $query); // doublequote unquoting
467 $query = str_replace('%s', "'%s'", $query); // quote the strings
468 array_walk($args, array(&$this, 'escape_by_ref'));
469 return @vsprintf($query, $args);
473 * Print SQL/DB error.
476 * @global array $EZSQL_ERROR Stores error information of query and error string
478 * @param string $str The error to display
479 * @return bool False if the showing of errors is disabled.
481 function print_error($str = '') {
484 if (!$str) $str = mysql_error($this->dbh);
485 $EZSQL_ERROR[] = array ('query' => $this->last_query, 'error_str' => $str);
487 if ( $this->suppress_errors )
490 if ( $caller = $this->get_caller() )
491 $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);
493 $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);
496 if ( ! function_exists('error_log') )
499 $log_file = @ini_get('error_log');
500 if ( !empty($log_file) && ('syslog' != $log_file) && !is_writable($log_file) )
504 @error_log($error_str, 0);
506 // Is error output turned on or not..
507 if ( !$this->show_errors )
510 $str = htmlspecialchars($str, ENT_QUOTES);
511 $query = htmlspecialchars($this->last_query, ENT_QUOTES);
513 // If there is an error then take note of it
514 print "<div id='error'>
515 <p class='wpdberror'><strong>WordPress database error:</strong> [$str]<br />
516 <code>$query</code></p>
521 * Enables showing of database errors.
523 * This function should be used only to enable showing of errors.
524 * wpdb::hide_errors() should be used instead for hiding of errors. However,
525 * this function can be used to enable and disable showing of database
530 * @param bool $show Whether to show or hide errors
531 * @return bool Old value for showing errors.
533 function show_errors( $show = true ) {
534 $errors = $this->show_errors;
535 $this->show_errors = $show;
540 * Disables showing of database errors.
544 * @return bool Whether showing of errors was active or not
546 function hide_errors() {
547 $show = $this->show_errors;
548 $this->show_errors = false;
553 * Whether to suppress database errors.
555 * @param unknown_type $suppress
558 function suppress_errors( $suppress = true ) {
559 $errors = $this->suppress_errors;
560 $this->suppress_errors = $suppress;
565 * Kill cached query results.
570 $this->last_result = array();
571 $this->col_info = null;
572 $this->last_query = null;
576 * Perform a MySQL database query, using current database connection.
578 * More information can be found on the codex page.
582 * @param string $query
585 function query($query) {
586 if ( ! $this->ready )
589 // filter the query, if filters are available
590 // NOTE: some queries are made before the plugins have been loaded, and thus cannot be filtered with this method
591 if ( function_exists('apply_filters') )
592 $query = apply_filters('query', $query);
598 // Log how the function was called
599 $this->func_call = "\$db->query(\"$query\")";
601 // Keep track of the last query for debug..
602 $this->last_query = $query;
604 // Perform the query via std mysql_query function..
605 if ( defined('SAVEQUERIES') && SAVEQUERIES )
606 $this->timer_start();
608 $this->result = @mysql_query($query, $this->dbh);
609 ++$this->num_queries;
611 if ( defined('SAVEQUERIES') && SAVEQUERIES )
612 $this->queries[] = array( $query, $this->timer_stop(), $this->get_caller() );
614 // If there is an error then take note of it..
615 if ( $this->last_error = mysql_error($this->dbh) ) {
616 $this->print_error();
620 if ( preg_match("/^\\s*(insert|delete|update|replace) /i",$query) ) {
621 $this->rows_affected = mysql_affected_rows($this->dbh);
622 // Take note of the insert_id
623 if ( preg_match("/^\\s*(insert|replace) /i",$query) ) {
624 $this->insert_id = mysql_insert_id($this->dbh);
626 // Return number of rows affected
627 $return_val = $this->rows_affected;
630 while ($i < @mysql_num_fields($this->result)) {
631 $this->col_info[$i] = @mysql_fetch_field($this->result);
635 while ( $row = @mysql_fetch_object($this->result) ) {
636 $this->last_result[$num_rows] = $row;
640 @mysql_free_result($this->result);
642 // Log number of rows the query returned
643 $this->num_rows = $num_rows;
645 // Return number of rows selected
646 $return_val = $this->num_rows;
653 * Insert an array of data into a table.
657 * @param string $table WARNING: not sanitized!
658 * @param array $data Should not already be SQL-escaped
659 * @return mixed Results of $this->query()
661 function insert($table, $data) {
662 $data = add_magic_quotes($data);
663 $fields = array_keys($data);
664 return $this->query("INSERT INTO $table (`" . implode('`,`',$fields) . "`) VALUES ('".implode("','",$data)."')");
668 * Update a row in the table with an array of data.
672 * @param string $table WARNING: not sanitized!
673 * @param array $data Should not already be SQL-escaped
674 * @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!
675 * @return mixed Results of $this->query()
677 function update($table, $data, $where){
678 $data = add_magic_quotes($data);
679 $bits = $wheres = array();
680 foreach ( array_keys($data) as $k )
681 $bits[] = "`$k` = '$data[$k]'";
683 if ( is_array( $where ) )
684 foreach ( $where as $c => $v )
685 $wheres[] = "$c = '" . $this->escape( $v ) . "'";
689 return $this->query( "UPDATE $table SET " . implode( ', ', $bits ) . ' WHERE ' . implode( ' AND ', $wheres ) );
693 * Retrieve one variable from the database.
695 * This combines the functionality of wpdb::get_row() and wpdb::get_col(),
696 * so both the column and row can be picked.
698 * It is possible to use this function without executing more queries. If
699 * you already made a query, you can set the $query to 'null' value and just
700 * retrieve either the column and row of the last query result.
704 * @param string $query Can be null as well, for caching
705 * @param int $x Column num to return
706 * @param int $y Row num to return
707 * @return mixed Database query results
709 function get_var($query=null, $x = 0, $y = 0) {
710 $this->func_call = "\$db->get_var(\"$query\",$x,$y)";
712 $this->query($query);
714 // Extract var out of cached results based x,y vals
715 if ( !empty( $this->last_result[$y] ) ) {
716 $values = array_values(get_object_vars($this->last_result[$y]));
719 // If there is a value return it else return null
720 return (isset($values[$x]) && $values[$x]!=='') ? $values[$x] : null;
724 * Retrieve one row from the database.
728 * @param string $query SQL query
729 * @param string $output ARRAY_A | ARRAY_N | OBJECT
730 * @param int $y Row num to return
731 * @return mixed Database query results
733 function get_row($query = null, $output = OBJECT, $y = 0) {
734 $this->func_call = "\$db->get_row(\"$query\",$output,$y)";
736 $this->query($query);
740 if ( !isset($this->last_result[$y]) )
743 if ( $output == OBJECT ) {
744 return $this->last_result[$y] ? $this->last_result[$y] : null;
745 } elseif ( $output == ARRAY_A ) {
746 return $this->last_result[$y] ? get_object_vars($this->last_result[$y]) : null;
747 } elseif ( $output == ARRAY_N ) {
748 return $this->last_result[$y] ? array_values(get_object_vars($this->last_result[$y])) : null;
750 $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*/);
755 * Retrieve one column from the database.
759 * @param string $query Can be null as well, for caching
760 * @param int $x Col num to return. Starts from 0.
761 * @return array Column results
763 function get_col($query = null , $x = 0) {
765 $this->query($query);
767 $new_array = array();
768 // Extract the column values
769 for ( $i=0; $i < count($this->last_result); $i++ ) {
770 $new_array[$i] = $this->get_var(null, $x, $i);
776 * Retrieve an entire result set from the database.
780 * @param string|null $query Can also be null to pull from the cache
781 * @param string $output ARRAY_A | ARRAY_N | OBJECT_K | OBJECT
782 * @return mixed Database query results
784 function get_results($query = null, $output = OBJECT) {
785 $this->func_call = "\$db->get_results(\"$query\", $output)";
788 $this->query($query);
792 if ( $output == OBJECT ) {
793 // Return an integer-keyed array of row objects
794 return $this->last_result;
795 } elseif ( $output == OBJECT_K ) {
796 // Return an array of row objects with keys from column 1
797 // (Duplicates are discarded)
798 foreach ( $this->last_result as $row ) {
799 $key = array_shift( get_object_vars( $row ) );
800 if ( !isset( $new_array[ $key ] ) )
801 $new_array[ $key ] = $row;
804 } elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
805 // Return an integer-keyed array of...
806 if ( $this->last_result ) {
808 foreach( $this->last_result as $row ) {
809 if ( $output == ARRAY_N ) {
810 // ...integer-keyed row arrays
811 $new_array[$i] = array_values( get_object_vars( $row ) );
813 // ...column name-keyed row arrays
814 $new_array[$i] = get_object_vars( $row );
824 * Retrieve column metadata from the last query.
828 * @param string $info_type one of name, table, def, max_length, not_null, primary_key, multiple_key, unique_key, numeric, blob, type, unsigned, zerofill
829 * @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
830 * @return mixed Column Results
832 function get_col_info($info_type = 'name', $col_offset = -1) {
833 if ( $this->col_info ) {
834 if ( $col_offset == -1 ) {
836 foreach($this->col_info as $col ) {
837 $new_array[$i] = $col->{$info_type};
842 return $this->col_info[$col_offset]->{$info_type};
848 * Starts the timer, for debugging purposes.
852 * @return bool Always returns true
854 function timer_start() {
855 $mtime = microtime();
856 $mtime = explode(' ', $mtime);
857 $this->time_start = $mtime[1] + $mtime[0];
862 * Stops the debugging timer.
866 * @return int Total time spent on the query, in milliseconds
868 function timer_stop() {
869 $mtime = microtime();
870 $mtime = explode(' ', $mtime);
871 $time_end = $mtime[1] + $mtime[0];
872 $time_total = $time_end - $this->time_start;
877 * Wraps fatal errors in a nice header and footer and dies.
881 * @param string $message
884 function bail($message) {
885 if ( !$this->show_errors ) {
886 if ( class_exists('WP_Error') )
887 $this->error = new WP_Error('500', $message);
889 $this->error = $message;
896 * Whether or not MySQL database is minimal required version.
903 function check_database_version()
906 // Make sure the server has MySQL 4.0
907 $mysql_version = preg_replace('|[^0-9\.]|', '', @mysql_get_server_info($this->dbh));
908 if ( version_compare($mysql_version, '4.0.0', '<') )
909 return new WP_Error('database_version',sprintf(__('<strong>ERROR</strong>: WordPress %s requires MySQL 4.0.0 or higher'), $wp_version));
913 * Whether of not the database version supports collation.
915 * Called when WordPress is generating the table scheme.
919 * @return bool True if collation is supported, false if version does not
921 function supports_collation()
923 return ( version_compare(mysql_get_server_info($this->dbh), '4.1.0', '>=') );
927 * Retrieve the name of the function that called wpdb.
929 * Requires PHP 4.3 and searches up the list of functions until it reaches
930 * the one that would most logically had called this method.
934 * @return string The name of the calling function
936 function get_caller() {
938 if ( !is_callable('debug_backtrace') )
941 $bt = debug_backtrace();
944 foreach ( $bt as $trace ) {
945 if ( @$trace['class'] == __CLASS__ )
947 elseif ( strtolower(@$trace['function']) == 'call_user_func_array' )
949 elseif ( strtolower(@$trace['function']) == 'apply_filters' )
951 elseif ( strtolower(@$trace['function']) == 'do_action' )
954 $caller = $trace['function'];
962 if ( ! isset($wpdb) ) {
964 * WordPress Database Object, if it isn't set already in wp-content/wpdb.php
965 * @global object $wpdb Creates a new wpdb object based on wp-config.php Constants for the database
968 $wpdb = new wpdb(DB_USER, DB_PASSWORD, DB_NAME, DB_HOST);