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 );
25 define( 'OBJECT_K', 'OBJECT_K' );
30 define( 'ARRAY_A', 'ARRAY_A' );
35 define( 'ARRAY_N', 'ARRAY_N' );
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/db.php
42 * file to your class. The wpdb class will still be included,
43 * so you can extend it or simply use your own.
45 * @link http://codex.wordpress.org/Function_Reference/wpdb_Class
48 * @subpackage Database
54 * Whether to show SQL/DB errors
60 var $show_errors = false;
63 * Whether to suppress errors during the DB bootstrapping.
69 var $suppress_errors = false;
72 * The last error during query.
80 * Amount of queries made
89 * Count of rows returned by previous query
98 * Count of affected rows by previous query
104 var $rows_affected = 0;
107 * The ID generated for an AUTO_INCREMENT column by the previous query (usually INSERT).
125 * Results of the last query made
134 * MySQL result, which is either a resource or boolean.
143 * Saved info on the table column
152 * Saved queries that were executed
161 * WordPress table prefix
163 * You can set this to have multiple WordPress installations
164 * in a single database. The second reason is for possible
165 * security precautions.
174 * Whether the database queries are ready to start executing.
183 * {@internal Missing Description}}
192 * {@internal Missing Description}}
201 * List of WordPress per-blog tables
205 * @see wpdb::tables()
208 var $tables = array( 'posts', 'comments', 'links', 'options', 'postmeta',
209 'terms', 'term_taxonomy', 'term_relationships', 'commentmeta' );
212 * List of deprecated WordPress tables
214 * categories, post2cat, and link2cat were deprecated in 2.3.0, db version 5539
218 * @see wpdb::tables()
221 var $old_tables = array( 'categories', 'post2cat', 'link2cat' );
224 * List of WordPress global tables
228 * @see wpdb::tables()
231 var $global_tables = array( 'users', 'usermeta' );
234 * List of Multisite global tables
238 * @see wpdb::tables()
241 var $ms_global_tables = array( 'blogs', 'signups', 'site', 'sitemeta',
242 'sitecategories', 'registration_log', 'blog_versions' );
245 * WordPress Comments table
254 * WordPress Comment Metadata table
263 * WordPress Links table
272 * WordPress Options table
281 * WordPress Post Metadata table
290 * WordPress Posts table
299 * WordPress Terms table
308 * WordPress Term Relationships table
314 var $term_relationships;
317 * WordPress Term Taxonomy table
326 * Global and Multisite tables
330 * WordPress User Metadata table
339 * WordPress Users table
348 * Multisite Blogs table
357 * Multisite Blog Versions table
366 * Multisite Registration Log table
372 var $registration_log;
375 * Multisite Signups table
384 * Multisite Sites table
393 * Multisite Sitewide Terms table
402 * Multisite Site Metadata table
411 * Format specifiers for DB columns. Columns not listed here default to %s. Initialized during WP load.
413 * Keys are column names, values are format types: 'ID' => '%d'
416 * @see wpdb::prepare()
417 * @see wpdb::insert()
418 * @see wpdb::update()
419 * @see wpdb::delete()
420 * @see wp_set_wpdb_vars()
424 var $field_types = array();
427 * Database table columns charset
436 * Database table columns collate
460 protected $dbpassword;
490 * A textual description of the last query/get_row/get_var call
499 * Whether MySQL is used as the database engine.
501 * Set in WPDB::db_connect() to true, by default. This is used when checking
502 * against the required MySQL version for WordPress. Normally, a replacement
503 * database drop-in (db.php) will skip these checks, but setting this to true
504 * will force the checks to occur.
510 public $is_mysql = null;
513 * Connects to the database server and selects a database
515 * PHP5 style constructor for compatibility with PHP5. Does
516 * the actual setting up of the class properties and connection
519 * @link http://core.trac.wordpress.org/ticket/3354
522 * @param string $dbuser MySQL database user
523 * @param string $dbpassword MySQL database password
524 * @param string $dbname MySQL database name
525 * @param string $dbhost MySQL database host
527 function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) {
528 register_shutdown_function( array( $this, '__destruct' ) );
530 if ( WP_DEBUG && WP_DEBUG_DISPLAY )
531 $this->show_errors();
533 $this->init_charset();
535 $this->dbuser = $dbuser;
536 $this->dbpassword = $dbpassword;
537 $this->dbname = $dbname;
538 $this->dbhost = $dbhost;
544 * PHP5 style destructor and will run when database object is destroyed.
546 * @see wpdb::__construct()
550 function __destruct() {
555 * PHP5 style magic getter, used to lazy-load expensive data.
559 * @param string $name The private member to get, and optionally process
560 * @return mixed The private member
562 function __get( $name ) {
563 if ( 'col_info' == $name )
564 $this->load_col_info();
570 * Magic function, for backwards compatibility
574 * @param string $name The private member to set
575 * @param mixed $value The value to set
577 function __set( $name, $value ) {
578 $this->$name = $value;
582 * Magic function, for backwards compatibility
586 * @param string $name The private member to check
588 * @return bool If the member is set or not
590 function __isset( $name ) {
591 return isset( $this->$name );
595 * Magic function, for backwards compatibility
599 * @param string $name The private member to unset
601 function __unset( $name ) {
602 unset( $this->$name );
606 * Set $this->charset and $this->collate
610 function init_charset() {
611 if ( function_exists('is_multisite') && is_multisite() ) {
612 $this->charset = 'utf8';
613 if ( defined( 'DB_COLLATE' ) && DB_COLLATE )
614 $this->collate = DB_COLLATE;
616 $this->collate = 'utf8_general_ci';
617 } elseif ( defined( 'DB_COLLATE' ) ) {
618 $this->collate = DB_COLLATE;
621 if ( defined( 'DB_CHARSET' ) )
622 $this->charset = DB_CHARSET;
626 * Sets the connection's character set.
630 * @param resource $dbh The resource given by mysql_connect
631 * @param string $charset The character set (optional)
632 * @param string $collate The collation (optional)
634 function set_charset( $dbh, $charset = null, $collate = null ) {
635 if ( ! isset( $charset ) )
636 $charset = $this->charset;
637 if ( ! isset( $collate ) )
638 $collate = $this->collate;
639 if ( $this->has_cap( 'collation' ) && ! empty( $charset ) ) {
640 if ( function_exists( 'mysql_set_charset' ) && $this->has_cap( 'set_charset' ) ) {
641 mysql_set_charset( $charset, $dbh );
643 $query = $this->prepare( 'SET NAMES %s', $charset );
644 if ( ! empty( $collate ) )
645 $query .= $this->prepare( ' COLLATE %s', $collate );
646 mysql_query( $query, $dbh );
652 * Sets the table prefix for the WordPress tables.
656 * @param string $prefix Alphanumeric name for the new prefix.
657 * @param bool $set_table_names Optional. Whether the table names, e.g. wpdb::$posts, should be updated or not.
658 * @return string|WP_Error Old prefix or WP_Error on error
660 function set_prefix( $prefix, $set_table_names = true ) {
662 if ( preg_match( '|[^a-z0-9_]|i', $prefix ) )
663 return new WP_Error('invalid_db_prefix', 'Invalid database prefix' );
665 $old_prefix = is_multisite() ? '' : $prefix;
667 if ( isset( $this->base_prefix ) )
668 $old_prefix = $this->base_prefix;
670 $this->base_prefix = $prefix;
672 if ( $set_table_names ) {
673 foreach ( $this->tables( 'global' ) as $table => $prefixed_table )
674 $this->$table = $prefixed_table;
676 if ( is_multisite() && empty( $this->blogid ) )
679 $this->prefix = $this->get_blog_prefix();
681 foreach ( $this->tables( 'blog' ) as $table => $prefixed_table )
682 $this->$table = $prefixed_table;
684 foreach ( $this->tables( 'old' ) as $table => $prefixed_table )
685 $this->$table = $prefixed_table;
695 * @param int $blog_id
696 * @param int $site_id Optional.
697 * @return string previous blog id
699 function set_blog_id( $blog_id, $site_id = 0 ) {
700 if ( ! empty( $site_id ) )
701 $this->siteid = $site_id;
703 $old_blog_id = $this->blogid;
704 $this->blogid = $blog_id;
706 $this->prefix = $this->get_blog_prefix();
708 foreach ( $this->tables( 'blog' ) as $table => $prefixed_table )
709 $this->$table = $prefixed_table;
711 foreach ( $this->tables( 'old' ) as $table => $prefixed_table )
712 $this->$table = $prefixed_table;
720 * @uses is_multisite()
722 * @param int $blog_id Optional.
723 * @return string Blog prefix.
725 function get_blog_prefix( $blog_id = null ) {
726 if ( is_multisite() ) {
727 if ( null === $blog_id )
728 $blog_id = $this->blogid;
729 $blog_id = (int) $blog_id;
730 if ( defined( 'MULTISITE' ) && ( 0 == $blog_id || 1 == $blog_id ) )
731 return $this->base_prefix;
733 return $this->base_prefix . $blog_id . '_';
735 return $this->base_prefix;
740 * Returns an array of WordPress tables.
742 * Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
743 * override the WordPress users and usermeta tables that would otherwise
744 * be determined by the prefix.
746 * The scope argument can take one of the following:
748 * 'all' - returns 'all' and 'global' tables. No old tables are returned.
749 * 'blog' - returns the blog-level tables for the queried blog.
750 * 'global' - returns the global tables for the installation, returning multisite tables only if running multisite.
751 * 'ms_global' - returns the multisite global tables, regardless if current installation is multisite.
752 * 'old' - returns tables which are deprecated.
755 * @uses wpdb::$tables
756 * @uses wpdb::$old_tables
757 * @uses wpdb::$global_tables
758 * @uses wpdb::$ms_global_tables
759 * @uses is_multisite()
761 * @param string $scope Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all.
762 * @param bool $prefix Optional. Whether to include table prefixes. Default true. If blog
763 * prefix is requested, then the custom users and usermeta tables will be mapped.
764 * @param int $blog_id Optional. The blog_id to prefix. Defaults to wpdb::$blogid. Used only when prefix is requested.
765 * @return array Table names. When a prefix is requested, the key is the unprefixed table name.
767 function tables( $scope = 'all', $prefix = true, $blog_id = 0 ) {
770 $tables = array_merge( $this->global_tables, $this->tables );
771 if ( is_multisite() )
772 $tables = array_merge( $tables, $this->ms_global_tables );
775 $tables = $this->tables;
778 $tables = $this->global_tables;
779 if ( is_multisite() )
780 $tables = array_merge( $tables, $this->ms_global_tables );
783 $tables = $this->ms_global_tables;
786 $tables = $this->old_tables;
795 $blog_id = $this->blogid;
796 $blog_prefix = $this->get_blog_prefix( $blog_id );
797 $base_prefix = $this->base_prefix;
798 $global_tables = array_merge( $this->global_tables, $this->ms_global_tables );
799 foreach ( $tables as $k => $table ) {
800 if ( in_array( $table, $global_tables ) )
801 $tables[ $table ] = $base_prefix . $table;
803 $tables[ $table ] = $blog_prefix . $table;
804 unset( $tables[ $k ] );
807 if ( isset( $tables['users'] ) && defined( 'CUSTOM_USER_TABLE' ) )
808 $tables['users'] = CUSTOM_USER_TABLE;
810 if ( isset( $tables['usermeta'] ) && defined( 'CUSTOM_USER_META_TABLE' ) )
811 $tables['usermeta'] = CUSTOM_USER_META_TABLE;
818 * Selects a database using the current database connection.
820 * The database name will be changed based on the current database
821 * connection. On failure, the execution will bail and display an DB error.
825 * @param string $db MySQL database name
826 * @param resource $dbh Optional link identifier.
827 * @return null Always null.
829 function select( $db, $dbh = null ) {
833 if ( !@mysql_select_db( $db, $dbh ) ) {
834 $this->ready = false;
835 wp_load_translations_early();
836 $this->bail( sprintf( __( '<h1>Can’t select database</h1>
837 <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>
839 <li>Are you sure it exists?</li>
840 <li>Does the user <code>%2$s</code> have permission to use the <code>%1$s</code> database?</li>
841 <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>
843 <p>If you don\'t know how to set up a database you should <strong>contact your host</strong>. If all else fails you may find help at the <a href="http://wordpress.org/support/">WordPress Support Forums</a>.</p>' ), htmlspecialchars( $db, ENT_QUOTES ), htmlspecialchars( $this->dbuser, ENT_QUOTES ) ), 'db_select_fail' );
849 * Do not use, deprecated.
851 * Use esc_sql() or wpdb::prepare() instead.
859 * @param string $string
862 function _weak_escape( $string ) {
863 if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) )
864 _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' );
865 return addslashes( $string );
869 * Real escape, using mysql_real_escape_string()
871 * @see mysql_real_escape_string()
875 * @param string $string to escape
876 * @return string escaped
878 function _real_escape( $string ) {
880 return mysql_real_escape_string( $string, $this->dbh );
882 $class = get_class( $this );
883 _doing_it_wrong( $class, "$class must set a database connection for use with escaping.", E_USER_NOTICE );
884 return addslashes( $string );
888 * Escape data. Works on arrays.
890 * @uses wpdb::_real_escape()
894 * @param string|array $data
895 * @return string|array escaped
897 function _escape( $data ) {
898 if ( is_array( $data ) ) {
899 foreach ( $data as $k => $v ) {
901 $data[$k] = $this->_escape( $v );
903 $data[$k] = $this->_real_escape( $v );
906 $data = $this->_real_escape( $data );
913 * Do not use, deprecated.
915 * Use esc_sql() or wpdb::prepare() instead.
919 * @see wpdb::prepare()
925 function escape( $data ) {
926 if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) )
927 _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' );
928 if ( is_array( $data ) ) {
929 foreach ( $data as $k => $v ) {
930 if ( is_array( $v ) )
931 $data[$k] = $this->escape( $v, 'recursive' );
933 $data[$k] = $this->_weak_escape( $v, 'internal' );
936 $data = $this->_weak_escape( $data, 'internal' );
943 * Escapes content by reference for insertion into the database, for security
945 * @uses wpdb::_real_escape()
947 * @param string $string to escape
950 function escape_by_ref( &$string ) {
951 if ( ! is_float( $string ) )
952 $string = $this->_real_escape( $string );
956 * Prepares a SQL query for safe execution. Uses sprintf()-like syntax.
958 * The following directives can be used in the query format string:
962 * %% (literal percentage sign - no argument needed)
964 * All of %d, %f, and %s are to be left unquoted in the query string and they need an argument passed for them.
965 * Literals (%) as parts of the query must be properly written as %%.
967 * This function only supports a small subset of the sprintf syntax; it only supports %d (integer), %f (float), and %s (string).
968 * Does not support sign, padding, alignment, width or precision specifiers.
969 * Does not support argument numbering/swapping.
971 * May be called like {@link http://php.net/sprintf sprintf()} or like {@link http://php.net/vsprintf vsprintf()}.
973 * Both %d and %s should be left unquoted in the query string.
976 * wpdb::prepare( "SELECT * FROM `table` WHERE `column` = %s AND `field` = %d", 'foo', 1337 )
977 * wpdb::prepare( "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo' );
980 * @link http://php.net/sprintf Description of syntax.
983 * @param string $query Query statement with sprintf()-like placeholders
984 * @param array|mixed $args The array of variables to substitute into the query's placeholders if being called like
985 * {@link http://php.net/vsprintf vsprintf()}, or the first variable to substitute into the query's placeholders if
986 * being called like {@link http://php.net/sprintf sprintf()}.
987 * @param mixed $args,... further variables to substitute into the query's placeholders if being called like
988 * {@link http://php.net/sprintf sprintf()}.
989 * @return null|false|string Sanitized query string, null if there is no query, false if there is an error and string
990 * if there was something to prepare
992 function prepare( $query, $args ) {
993 if ( is_null( $query ) )
996 $args = func_get_args();
997 array_shift( $args );
998 // If args were passed as an array (as in vsprintf), move them up
999 if ( isset( $args[0] ) && is_array($args[0]) )
1001 $query = str_replace( "'%s'", '%s', $query ); // in case someone mistakenly already singlequoted it
1002 $query = str_replace( '"%s"', '%s', $query ); // doublequote unquoting
1003 $query = preg_replace( '|(?<!%)%f|' , '%F', $query ); // Force floats to be locale unaware
1004 $query = preg_replace( '|(?<!%)%s|', "'%s'", $query ); // quote the strings, avoiding escaped strings like %%s
1005 array_walk( $args, array( $this, 'escape_by_ref' ) );
1006 return @vsprintf( $query, $args );
1010 * Print SQL/DB error.
1013 * @global array $EZSQL_ERROR Stores error information of query and error string
1015 * @param string $str The error to display
1016 * @return bool False if the showing of errors is disabled.
1018 function print_error( $str = '' ) {
1019 global $EZSQL_ERROR;
1022 $str = mysql_error( $this->dbh );
1023 $EZSQL_ERROR[] = array( 'query' => $this->last_query, 'error_str' => $str );
1025 if ( $this->suppress_errors )
1028 wp_load_translations_early();
1030 if ( $caller = $this->get_caller() )
1031 $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s made by %3$s' ), $str, $this->last_query, $caller );
1033 $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s' ), $str, $this->last_query );
1035 error_log( $error_str );
1037 // Are we showing errors?
1038 if ( ! $this->show_errors )
1041 // If there is an error then take note of it
1042 if ( is_multisite() ) {
1043 $msg = "WordPress database error: [$str]\n{$this->last_query}\n";
1044 if ( defined( 'ERRORLOGFILE' ) )
1045 error_log( $msg, 3, ERRORLOGFILE );
1046 if ( defined( 'DIEONDBERROR' ) )
1049 $str = htmlspecialchars( $str, ENT_QUOTES );
1050 $query = htmlspecialchars( $this->last_query, ENT_QUOTES );
1052 print "<div id='error'>
1053 <p class='wpdberror'><strong>WordPress database error:</strong> [$str]<br />
1054 <code>$query</code></p>
1060 * Enables showing of database errors.
1062 * This function should be used only to enable showing of errors.
1063 * wpdb::hide_errors() should be used instead for hiding of errors. However,
1064 * this function can be used to enable and disable showing of database
1068 * @see wpdb::hide_errors()
1070 * @param bool $show Whether to show or hide errors
1071 * @return bool Old value for showing errors.
1073 function show_errors( $show = true ) {
1074 $errors = $this->show_errors;
1075 $this->show_errors = $show;
1080 * Disables showing of database errors.
1082 * By default database errors are not shown.
1085 * @see wpdb::show_errors()
1087 * @return bool Whether showing of errors was active
1089 function hide_errors() {
1090 $show = $this->show_errors;
1091 $this->show_errors = false;
1096 * Whether to suppress database errors.
1098 * By default database errors are suppressed, with a simple
1099 * call to this function they can be enabled.
1102 * @see wpdb::hide_errors()
1103 * @param bool $suppress Optional. New value. Defaults to true.
1104 * @return bool Old value
1106 function suppress_errors( $suppress = true ) {
1107 $errors = $this->suppress_errors;
1108 $this->suppress_errors = (bool) $suppress;
1113 * Kill cached query results.
1119 $this->last_result = array();
1120 $this->col_info = null;
1121 $this->last_query = null;
1122 $this->rows_affected = $this->num_rows = 0;
1123 $this->last_error = '';
1125 if ( is_resource( $this->result ) )
1126 mysql_free_result( $this->result );
1130 * Connect to and select database
1134 function db_connect() {
1136 $this->is_mysql = true;
1138 $new_link = defined( 'MYSQL_NEW_LINK' ) ? MYSQL_NEW_LINK : true;
1139 $client_flags = defined( 'MYSQL_CLIENT_FLAGS' ) ? MYSQL_CLIENT_FLAGS : 0;
1142 $this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
1144 $this->dbh = @mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
1147 if ( !$this->dbh ) {
1148 wp_load_translations_early();
1149 $this->bail( sprintf( __( "
1150 <h1>Error establishing a database connection</h1>
1151 <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>
1153 <li>Are you sure you have the correct username and password?</li>
1154 <li>Are you sure that you have typed the correct hostname?</li>
1155 <li>Are you sure that the database server is running?</li>
1157 <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>
1158 " ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' );
1163 $this->set_charset( $this->dbh );
1165 $this->ready = true;
1167 $this->select( $this->dbname, $this->dbh );
1171 * Perform a MySQL database query, using current database connection.
1173 * More information can be found on the codex page.
1177 * @param string $query Database query
1178 * @return int|false Number of rows affected/selected or false on error
1180 function query( $query ) {
1181 if ( ! $this->ready )
1184 * Filter the database query.
1186 * Some queries are made before the plugins have been loaded, and thus cannot be filtered with this method.
1189 * @param string $query Database query.
1191 $query = apply_filters( 'query', $query );
1196 // Log how the function was called
1197 $this->func_call = "\$db->query(\"$query\")";
1199 // Keep track of the last query for debug..
1200 $this->last_query = $query;
1202 if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES )
1203 $this->timer_start();
1205 $this->result = @mysql_query( $query, $this->dbh );
1206 $this->num_queries++;
1208 if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES )
1209 $this->queries[] = array( $query, $this->timer_stop(), $this->get_caller() );
1211 // If there is an error then take note of it..
1212 if ( $this->last_error = mysql_error( $this->dbh ) ) {
1213 // Clear insert_id on a subsequent failed insert.
1214 if ( $this->insert_id && preg_match( '/^\s*(insert|replace)\s/i', $query ) )
1215 $this->insert_id = 0;
1217 $this->print_error();
1221 if ( preg_match( '/^\s*(create|alter|truncate|drop)\s/i', $query ) ) {
1222 $return_val = $this->result;
1223 } elseif ( preg_match( '/^\s*(insert|delete|update|replace)\s/i', $query ) ) {
1224 $this->rows_affected = mysql_affected_rows( $this->dbh );
1225 // Take note of the insert_id
1226 if ( preg_match( '/^\s*(insert|replace)\s/i', $query ) ) {
1227 $this->insert_id = mysql_insert_id($this->dbh);
1229 // Return number of rows affected
1230 $return_val = $this->rows_affected;
1233 while ( $row = @mysql_fetch_object( $this->result ) ) {
1234 $this->last_result[$num_rows] = $row;
1238 // Log number of rows the query returned
1239 // and return number of rows selected
1240 $this->num_rows = $num_rows;
1241 $return_val = $num_rows;
1248 * Insert a row into a table.
1251 * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
1252 * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
1256 * @see wpdb::prepare()
1257 * @see wpdb::$field_types
1258 * @see wp_set_wpdb_vars()
1260 * @param string $table table name
1261 * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
1262 * @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.
1263 * A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
1264 * @return int|false The number of rows inserted, or false on error.
1266 function insert( $table, $data, $format = null ) {
1267 return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' );
1271 * Replace a row into a table.
1274 * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
1275 * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
1279 * @see wpdb::prepare()
1280 * @see wpdb::$field_types
1281 * @see wp_set_wpdb_vars()
1283 * @param string $table table name
1284 * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
1285 * @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.
1286 * A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
1287 * @return int|false The number of rows affected, or false on error.
1289 function replace( $table, $data, $format = null ) {
1290 return $this->_insert_replace_helper( $table, $data, $format, 'REPLACE' );
1294 * Helper function for insert and replace.
1296 * Runs an insert or replace query based on $type argument.
1300 * @see wpdb::prepare()
1301 * @see wpdb::$field_types
1302 * @see wp_set_wpdb_vars()
1304 * @param string $table table name
1305 * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
1306 * @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.
1307 * A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
1308 * @param string $type Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT.
1309 * @return int|false The number of rows affected, or false on error.
1311 function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {
1312 if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ) ) )
1314 $this->insert_id = 0;
1315 $formats = $format = (array) $format;
1316 $fields = array_keys( $data );
1317 $formatted_fields = array();
1318 foreach ( $fields as $field ) {
1319 if ( !empty( $format ) )
1320 $form = ( $form = array_shift( $formats ) ) ? $form : $format[0];
1321 elseif ( isset( $this->field_types[$field] ) )
1322 $form = $this->field_types[$field];
1325 $formatted_fields[] = $form;
1327 $sql = "{$type} INTO `$table` (`" . implode( '`,`', $fields ) . "`) VALUES (" . implode( ",", $formatted_fields ) . ")";
1328 return $this->query( $this->prepare( $sql, $data ) );
1332 * Update a row in the table
1335 * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 'bar' ), array( 'ID' => 1 ) )
1336 * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) )
1340 * @see wpdb::prepare()
1341 * @see wpdb::$field_types
1342 * @see wp_set_wpdb_vars()
1344 * @param string $table table name
1345 * @param array $data Data to update (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
1346 * @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".
1347 * @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.
1348 * A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
1349 * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where. A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $where will be treated as strings.
1350 * @return int|false The number of rows updated, or false on error.
1352 function update( $table, $data, $where, $format = null, $where_format = null ) {
1353 if ( ! is_array( $data ) || ! is_array( $where ) )
1356 $formats = $format = (array) $format;
1357 $bits = $wheres = array();
1358 foreach ( (array) array_keys( $data ) as $field ) {
1359 if ( !empty( $format ) )
1360 $form = ( $form = array_shift( $formats ) ) ? $form : $format[0];
1361 elseif ( isset($this->field_types[$field]) )
1362 $form = $this->field_types[$field];
1365 $bits[] = "`$field` = {$form}";
1368 $where_formats = $where_format = (array) $where_format;
1369 foreach ( (array) array_keys( $where ) as $field ) {
1370 if ( !empty( $where_format ) )
1371 $form = ( $form = array_shift( $where_formats ) ) ? $form : $where_format[0];
1372 elseif ( isset( $this->field_types[$field] ) )
1373 $form = $this->field_types[$field];
1376 $wheres[] = "`$field` = {$form}";
1379 $sql = "UPDATE `$table` SET " . implode( ', ', $bits ) . ' WHERE ' . implode( ' AND ', $wheres );
1380 return $this->query( $this->prepare( $sql, array_merge( array_values( $data ), array_values( $where ) ) ) );
1384 * Delete a row in the table
1387 * wpdb::delete( 'table', array( 'ID' => 1 ) )
1388 * wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) )
1392 * @see wpdb::prepare()
1393 * @see wpdb::$field_types
1394 * @see wp_set_wpdb_vars()
1396 * @param string $table table name
1397 * @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".
1398 * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where. A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $where will be treated as strings unless otherwise specified in wpdb::$field_types.
1399 * @return int|false The number of rows updated, or false on error.
1401 function delete( $table, $where, $where_format = null ) {
1402 if ( ! is_array( $where ) )
1405 $bits = $wheres = array();
1407 $where_formats = $where_format = (array) $where_format;
1409 foreach ( array_keys( $where ) as $field ) {
1410 if ( !empty( $where_format ) ) {
1411 $form = ( $form = array_shift( $where_formats ) ) ? $form : $where_format[0];
1412 } elseif ( isset( $this->field_types[ $field ] ) ) {
1413 $form = $this->field_types[ $field ];
1418 $wheres[] = "$field = $form";
1421 $sql = "DELETE FROM $table WHERE " . implode( ' AND ', $wheres );
1422 return $this->query( $this->prepare( $sql, $where ) );
1427 * Retrieve one variable from the database.
1429 * Executes a SQL query and returns the value from the SQL result.
1430 * 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.
1431 * If $query is null, this function returns the value in the specified column and row from the previous SQL result.
1435 * @param string|null $query Optional. SQL query. Defaults to null, use the result from the previous query.
1436 * @param int $x Optional. Column of value to return. Indexed from 0.
1437 * @param int $y Optional. Row of value to return. Indexed from 0.
1438 * @return string|null Database query result (as string), or null on failure
1440 function get_var( $query = null, $x = 0, $y = 0 ) {
1441 $this->func_call = "\$db->get_var(\"$query\", $x, $y)";
1443 $this->query( $query );
1445 // Extract var out of cached results based x,y vals
1446 if ( !empty( $this->last_result[$y] ) ) {
1447 $values = array_values( get_object_vars( $this->last_result[$y] ) );
1450 // If there is a value return it else return null
1451 return ( isset( $values[$x] ) && $values[$x] !== '' ) ? $values[$x] : null;
1455 * Retrieve one row from the database.
1457 * Executes a SQL query and returns the row from the SQL result.
1461 * @param string|null $query SQL query.
1462 * @param string $output Optional. one of ARRAY_A | ARRAY_N | OBJECT constants. Return an associative array (column => value, ...),
1463 * a numerically indexed array (0 => value, ...) or an object ( ->column = value ), respectively.
1464 * @param int $y Optional. Row to return. Indexed from 0.
1465 * @return mixed Database query result in format specified by $output or null on failure
1467 function get_row( $query = null, $output = OBJECT, $y = 0 ) {
1468 $this->func_call = "\$db->get_row(\"$query\",$output,$y)";
1470 $this->query( $query );
1474 if ( !isset( $this->last_result[$y] ) )
1477 if ( $output == OBJECT ) {
1478 return $this->last_result[$y] ? $this->last_result[$y] : null;
1479 } elseif ( $output == ARRAY_A ) {
1480 return $this->last_result[$y] ? get_object_vars( $this->last_result[$y] ) : null;
1481 } elseif ( $output == ARRAY_N ) {
1482 return $this->last_result[$y] ? array_values( get_object_vars( $this->last_result[$y] ) ) : null;
1484 $this->print_error( " \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N" );
1489 * Retrieve one column from the database.
1491 * Executes a SQL query and returns the column from the SQL result.
1492 * If the SQL result contains more than one column, this function returns the column specified.
1493 * If $query is null, this function returns the specified column from the previous SQL result.
1497 * @param string|null $query Optional. SQL query. Defaults to previous query.
1498 * @param int $x Optional. Column to return. Indexed from 0.
1499 * @return array Database query result. Array indexed from 0 by SQL result row number.
1501 function get_col( $query = null , $x = 0 ) {
1503 $this->query( $query );
1505 $new_array = array();
1506 // Extract the column values
1507 for ( $i = 0, $j = count( $this->last_result ); $i < $j; $i++ ) {
1508 $new_array[$i] = $this->get_var( null, $x, $i );
1514 * Retrieve an entire SQL result set from the database (i.e., many rows)
1516 * Executes a SQL query and returns the entire SQL result.
1520 * @param string $query SQL query.
1521 * @param string $output Optional. Any of ARRAY_A | ARRAY_N | OBJECT | OBJECT_K constants. With one of the first three, return an array of rows indexed from 0 by SQL result row number.
1522 * Each row is an associative array (column => value, ...), a numerically indexed array (0 => value, ...), or an object. ( ->column = value ), respectively.
1523 * 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.
1524 * @return mixed Database query results
1526 function get_results( $query = null, $output = OBJECT ) {
1527 $this->func_call = "\$db->get_results(\"$query\", $output)";
1530 $this->query( $query );
1534 $new_array = array();
1535 if ( $output == OBJECT ) {
1536 // Return an integer-keyed array of row objects
1537 return $this->last_result;
1538 } elseif ( $output == OBJECT_K ) {
1539 // Return an array of row objects with keys from column 1
1540 // (Duplicates are discarded)
1541 foreach ( $this->last_result as $row ) {
1542 $var_by_ref = get_object_vars( $row );
1543 $key = array_shift( $var_by_ref );
1544 if ( ! isset( $new_array[ $key ] ) )
1545 $new_array[ $key ] = $row;
1548 } elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
1549 // Return an integer-keyed array of...
1550 if ( $this->last_result ) {
1551 foreach( (array) $this->last_result as $row ) {
1552 if ( $output == ARRAY_N ) {
1553 // ...integer-keyed row arrays
1554 $new_array[] = array_values( get_object_vars( $row ) );
1556 // ...column name-keyed row arrays
1557 $new_array[] = get_object_vars( $row );
1567 * Load the column metadata from the last query.
1573 protected function load_col_info() {
1574 if ( $this->col_info )
1577 for ( $i = 0; $i < @mysql_num_fields( $this->result ); $i++ ) {
1578 $this->col_info[ $i ] = @mysql_fetch_field( $this->result, $i );
1583 * Retrieve column metadata from the last query.
1587 * @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
1588 * @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
1589 * @return mixed Column Results
1591 function get_col_info( $info_type = 'name', $col_offset = -1 ) {
1592 $this->load_col_info();
1594 if ( $this->col_info ) {
1595 if ( $col_offset == -1 ) {
1597 $new_array = array();
1598 foreach( (array) $this->col_info as $col ) {
1599 $new_array[$i] = $col->{$info_type};
1604 return $this->col_info[$col_offset]->{$info_type};
1610 * Starts the timer, for debugging purposes.
1616 function timer_start() {
1617 $this->time_start = microtime( true );
1622 * Stops the debugging timer.
1626 * @return float Total time spent on the query, in seconds
1628 function timer_stop() {
1629 return ( microtime( true ) - $this->time_start );
1633 * Wraps errors in a nice header and footer and dies.
1635 * Will not die if wpdb::$show_errors is false.
1639 * @param string $message The Error message
1640 * @param string $error_code Optional. A Computer readable string to identify the error.
1641 * @return false|void
1643 function bail( $message, $error_code = '500' ) {
1644 if ( !$this->show_errors ) {
1645 if ( class_exists( 'WP_Error' ) )
1646 $this->error = new WP_Error($error_code, $message);
1648 $this->error = $message;
1655 * Whether MySQL database is at least the required minimum version.
1659 * @uses $required_mysql_version
1663 function check_database_version() {
1664 global $wp_version, $required_mysql_version;
1665 // Make sure the server has the required MySQL version
1666 if ( version_compare($this->db_version(), $required_mysql_version, '<') )
1667 return new WP_Error('database_version', sprintf( __( '<strong>ERROR</strong>: WordPress %1$s requires MySQL %2$s or higher' ), $wp_version, $required_mysql_version ));
1671 * Whether the database supports collation.
1673 * Called when WordPress is generating the table scheme.
1677 * @deprecated Use wpdb::has_cap( 'collation' )
1679 * @return bool True if collation is supported, false if version does not
1681 function supports_collation() {
1682 _deprecated_function( __FUNCTION__, '3.5', 'wpdb::has_cap( \'collation\' )' );
1683 return $this->has_cap( 'collation' );
1687 * The database character collate.
1691 * @return string The database character collate.
1693 public function get_charset_collate() {
1694 $charset_collate = '';
1696 if ( ! empty( $this->charset ) )
1697 $charset_collate = "DEFAULT CHARACTER SET $this->charset";
1698 if ( ! empty( $this->collate ) )
1699 $charset_collate .= " COLLATE $this->collate";
1701 return $charset_collate;
1705 * Determine if a database supports a particular feature.
1708 * @see wpdb::db_version()
1710 * @param string $db_cap The feature to check for.
1713 function has_cap( $db_cap ) {
1714 $version = $this->db_version();
1716 switch ( strtolower( $db_cap ) ) {
1717 case 'collation' : // @since 2.5.0
1718 case 'group_concat' : // @since 2.7.0
1719 case 'subqueries' : // @since 2.7.0
1720 return version_compare( $version, '4.1', '>=' );
1721 case 'set_charset' :
1722 return version_compare( $version, '5.0.7', '>=' );
1729 * Retrieve the name of the function that called wpdb.
1731 * Searches up the list of functions until it reaches
1732 * the one that would most logically had called this method.
1736 * @return string The name of the calling function
1738 function get_caller() {
1739 return wp_debug_backtrace_summary( __CLASS__ );
1743 * The database version number.
1747 * @return false|string false on failure, version number on success
1749 function db_version() {
1750 return preg_replace( '/[^0-9.].*/', '', mysql_get_server_info( $this->dbh ) );