5 * Original code from {@link http://php.justinvincent.com Justin Vincent (justin@visunet.ie)}
15 define( 'EZSQL_VERSION', 'WP1.25' );
20 define( 'OBJECT', 'OBJECT' );
21 define( 'object', 'OBJECT' ); // Back compat.
26 define( 'OBJECT_K', 'OBJECT_K' );
31 define( 'ARRAY_A', 'ARRAY_A' );
36 define( 'ARRAY_N', 'ARRAY_N' );
39 * WordPress Database Access Abstraction Object
41 * It is possible to replace this class with your own
42 * by setting the $wpdb global variable in wp-content/db.php
43 * file to your class. The wpdb class will still be included,
44 * so you can extend it or simply use your own.
46 * @link https://codex.wordpress.org/Function_Reference/wpdb_Class
49 * @subpackage Database
55 * Whether to show SQL/DB errors.
57 * Default behavior is to show errors if both WP_DEBUG and WP_DEBUG_DISPLAY
64 var $show_errors = false;
67 * Whether to suppress errors during the DB bootstrapping.
73 var $suppress_errors = false;
76 * The last error during query.
81 public $last_error = '';
84 * Amount of queries made
90 public $num_queries = 0;
93 * Count of rows returned by previous query
102 * Count of affected rows by previous query
108 var $rows_affected = 0;
111 * The ID generated for an AUTO_INCREMENT column by the previous query (usually INSERT).
117 public $insert_id = 0;
129 * Results of the last query made
138 * MySQL result, which is either a resource or boolean.
147 * Cached column info, for sanity checking data before inserting
153 protected $col_meta = array();
156 * Calculated character sets on tables
162 protected $table_charset = array();
165 * Whether text fields in the current query need to be sanity checked.
171 protected $check_current_query = true;
174 * Flag to ensure we don't run into recursion problems when checking the collation.
178 * @see wpdb::check_safe_collation()
181 private $checking_collation = false;
184 * Saved info on the table column
193 * Saved queries that were executed
202 * The number of times to retry reconnecting before dying.
206 * @see wpdb::check_connection()
209 protected $reconnect_retries = 5;
212 * WordPress table prefix
214 * You can set this to have multiple WordPress installations
215 * in a single database. The second reason is for possible
216 * security precautions.
225 * WordPress base table prefix.
234 * Whether the database queries are ready to start executing.
261 * List of WordPress per-blog tables
265 * @see wpdb::tables()
268 var $tables = array( 'posts', 'comments', 'links', 'options', 'postmeta',
269 'terms', 'term_taxonomy', 'term_relationships', 'commentmeta' );
272 * List of deprecated WordPress tables
274 * categories, post2cat, and link2cat were deprecated in 2.3.0, db version 5539
278 * @see wpdb::tables()
281 var $old_tables = array( 'categories', 'post2cat', 'link2cat' );
284 * List of WordPress global tables
288 * @see wpdb::tables()
291 var $global_tables = array( 'users', 'usermeta' );
294 * List of Multisite global tables
298 * @see wpdb::tables()
301 var $ms_global_tables = array( 'blogs', 'signups', 'site', 'sitemeta',
302 'sitecategories', 'registration_log', 'blog_versions' );
305 * WordPress Comments table
314 * WordPress Comment Metadata table
323 * WordPress Links table
332 * WordPress Options table
341 * WordPress Post Metadata table
350 * WordPress Posts table
359 * WordPress Terms table
368 * WordPress Term Relationships table
374 public $term_relationships;
377 * WordPress Term Taxonomy table
383 public $term_taxonomy;
386 * Global and Multisite tables
390 * WordPress User Metadata table
399 * WordPress Users table
408 * Multisite Blogs table
417 * Multisite Blog Versions table
423 public $blog_versions;
426 * Multisite Registration Log table
432 public $registration_log;
435 * Multisite Signups table
444 * Multisite Sites table
453 * Multisite Sitewide Terms table
459 public $sitecategories;
462 * Multisite Site Metadata table
471 * Format specifiers for DB columns. Columns not listed here default to %s. Initialized during WP load.
473 * Keys are column names, values are format types: 'ID' => '%d'
476 * @see wpdb::prepare()
477 * @see wpdb::insert()
478 * @see wpdb::update()
479 * @see wpdb::delete()
480 * @see wp_set_wpdb_vars()
484 public $field_types = array();
487 * Database table columns charset
496 * Database table columns collate
520 protected $dbpassword;
550 * A textual description of the last query/get_row/get_var call
559 * Whether MySQL is used as the database engine.
561 * Set in WPDB::db_connect() to true, by default. This is used when checking
562 * against the required MySQL version for WordPress. Normally, a replacement
563 * database drop-in (db.php) will skip these checks, but setting this to true
564 * will force the checks to occur.
570 public $is_mysql = null;
573 * A list of incompatible SQL modes.
579 protected $incompatible_modes = array( 'NO_ZERO_DATE', 'ONLY_FULL_GROUP_BY',
580 'STRICT_TRANS_TABLES', 'STRICT_ALL_TABLES', 'TRADITIONAL' );
583 * Whether to use mysqli over mysql.
589 private $use_mysqli = false;
592 * Whether we've managed to successfully connect at some point
598 private $has_connected = false;
601 * Connects to the database server and selects a database
603 * PHP5 style constructor for compatibility with PHP5. Does
604 * the actual setting up of the class properties and connection
607 * @link https://core.trac.wordpress.org/ticket/3354
610 * @global string $wp_version
612 * @param string $dbuser MySQL database user
613 * @param string $dbpassword MySQL database password
614 * @param string $dbname MySQL database name
615 * @param string $dbhost MySQL database host
617 public function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) {
618 register_shutdown_function( array( $this, '__destruct' ) );
620 if ( WP_DEBUG && WP_DEBUG_DISPLAY )
621 $this->show_errors();
623 /* Use ext/mysqli if it exists and:
624 * - WP_USE_EXT_MYSQL is defined as false, or
625 * - We are a development version of WordPress, or
626 * - We are running PHP 5.5 or greater, or
627 * - ext/mysql is not loaded.
629 if ( function_exists( 'mysqli_connect' ) ) {
630 if ( defined( 'WP_USE_EXT_MYSQL' ) ) {
631 $this->use_mysqli = ! WP_USE_EXT_MYSQL;
632 } elseif ( version_compare( phpversion(), '5.5', '>=' ) || ! function_exists( 'mysql_connect' ) ) {
633 $this->use_mysqli = true;
634 } elseif ( false !== strpos( $GLOBALS['wp_version'], '-' ) ) {
635 $this->use_mysqli = true;
639 $this->dbuser = $dbuser;
640 $this->dbpassword = $dbpassword;
641 $this->dbname = $dbname;
642 $this->dbhost = $dbhost;
644 // wp-config.php creation will manually connect when ready.
645 if ( defined( 'WP_SETUP_CONFIG' ) ) {
653 * PHP5 style destructor and will run when database object is destroyed.
655 * @see wpdb::__construct()
659 public function __destruct() {
664 * PHP5 style magic getter, used to lazy-load expensive data.
668 * @param string $name The private member to get, and optionally process
669 * @return mixed The private member
671 public function __get( $name ) {
672 if ( 'col_info' === $name )
673 $this->load_col_info();
679 * Magic function, for backwards compatibility.
683 * @param string $name The private member to set
684 * @param mixed $value The value to set
686 public function __set( $name, $value ) {
687 $protected_members = array(
690 'check_current_query',
692 if ( in_array( $name, $protected_members, true ) ) {
695 $this->$name = $value;
699 * Magic function, for backwards compatibility.
703 * @param string $name The private member to check
705 * @return bool If the member is set or not
707 public function __isset( $name ) {
708 return isset( $this->$name );
712 * Magic function, for backwards compatibility.
716 * @param string $name The private member to unset
718 public function __unset( $name ) {
719 unset( $this->$name );
723 * Set $this->charset and $this->collate
727 public function init_charset() {
728 if ( function_exists('is_multisite') && is_multisite() ) {
729 $this->charset = 'utf8';
730 if ( defined( 'DB_COLLATE' ) && DB_COLLATE ) {
731 $this->collate = DB_COLLATE;
733 $this->collate = 'utf8_general_ci';
735 } elseif ( defined( 'DB_COLLATE' ) ) {
736 $this->collate = DB_COLLATE;
739 if ( defined( 'DB_CHARSET' ) ) {
740 $this->charset = DB_CHARSET;
743 if ( ( $this->use_mysqli && ! ( $this->dbh instanceof mysqli ) ) || empty( $this->dbh ) ) {
747 if ( 'utf8' === $this->charset && $this->has_cap( 'utf8mb4' ) ) {
748 $this->charset = 'utf8mb4';
751 if ( 'utf8mb4' === $this->charset && ( ! $this->collate || stripos( $this->collate, 'utf8_' ) === 0 ) ) {
752 $this->collate = 'utf8mb4_unicode_ci';
757 * Sets the connection's character set.
761 * @param resource $dbh The resource given by mysql_connect
762 * @param string $charset Optional. The character set. Default null.
763 * @param string $collate Optional. The collation. Default null.
765 public function set_charset( $dbh, $charset = null, $collate = null ) {
766 if ( ! isset( $charset ) )
767 $charset = $this->charset;
768 if ( ! isset( $collate ) )
769 $collate = $this->collate;
770 if ( $this->has_cap( 'collation' ) && ! empty( $charset ) ) {
771 if ( $this->use_mysqli ) {
772 if ( function_exists( 'mysqli_set_charset' ) && $this->has_cap( 'set_charset' ) ) {
773 mysqli_set_charset( $dbh, $charset );
775 $query = $this->prepare( 'SET NAMES %s', $charset );
776 if ( ! empty( $collate ) )
777 $query .= $this->prepare( ' COLLATE %s', $collate );
778 mysqli_query( $dbh, $query );
781 if ( function_exists( 'mysql_set_charset' ) && $this->has_cap( 'set_charset' ) ) {
782 mysql_set_charset( $charset, $dbh );
784 $query = $this->prepare( 'SET NAMES %s', $charset );
785 if ( ! empty( $collate ) )
786 $query .= $this->prepare( ' COLLATE %s', $collate );
787 mysql_query( $query, $dbh );
794 * Change the current SQL mode, and ensure its WordPress compatibility.
796 * If no modes are passed, it will ensure the current MySQL server
797 * modes are compatible.
801 * @param array $modes Optional. A list of SQL modes to set.
803 public function set_sql_mode( $modes = array() ) {
804 if ( empty( $modes ) ) {
805 if ( $this->use_mysqli ) {
806 $res = mysqli_query( $this->dbh, 'SELECT @@SESSION.sql_mode' );
808 $res = mysql_query( 'SELECT @@SESSION.sql_mode', $this->dbh );
811 if ( empty( $res ) ) {
815 if ( $this->use_mysqli ) {
816 $modes_array = mysqli_fetch_array( $res );
817 if ( empty( $modes_array[0] ) ) {
820 $modes_str = $modes_array[0];
822 $modes_str = mysql_result( $res, 0 );
825 if ( empty( $modes_str ) ) {
829 $modes = explode( ',', $modes_str );
832 $modes = array_change_key_case( $modes, CASE_UPPER );
835 * Filter the list of incompatible SQL modes to exclude.
839 * @param array $incompatible_modes An array of incompatible modes.
841 $incompatible_modes = (array) apply_filters( 'incompatible_sql_modes', $this->incompatible_modes );
843 foreach( $modes as $i => $mode ) {
844 if ( in_array( $mode, $incompatible_modes ) ) {
845 unset( $modes[ $i ] );
849 $modes_str = implode( ',', $modes );
851 if ( $this->use_mysqli ) {
852 mysqli_query( $this->dbh, "SET SESSION sql_mode='$modes_str'" );
854 mysql_query( "SET SESSION sql_mode='$modes_str'", $this->dbh );
859 * Sets the table prefix for the WordPress tables.
863 * @param string $prefix Alphanumeric name for the new prefix.
864 * @param bool $set_table_names Optional. Whether the table names, e.g. wpdb::$posts, should be updated or not.
865 * @return string|WP_Error Old prefix or WP_Error on error
867 public function set_prefix( $prefix, $set_table_names = true ) {
869 if ( preg_match( '|[^a-z0-9_]|i', $prefix ) )
870 return new WP_Error('invalid_db_prefix', 'Invalid database prefix' );
872 $old_prefix = is_multisite() ? '' : $prefix;
874 if ( isset( $this->base_prefix ) )
875 $old_prefix = $this->base_prefix;
877 $this->base_prefix = $prefix;
879 if ( $set_table_names ) {
880 foreach ( $this->tables( 'global' ) as $table => $prefixed_table )
881 $this->$table = $prefixed_table;
883 if ( is_multisite() && empty( $this->blogid ) )
886 $this->prefix = $this->get_blog_prefix();
888 foreach ( $this->tables( 'blog' ) as $table => $prefixed_table )
889 $this->$table = $prefixed_table;
891 foreach ( $this->tables( 'old' ) as $table => $prefixed_table )
892 $this->$table = $prefixed_table;
903 * @param int $blog_id
904 * @param int $site_id Optional.
905 * @return int previous blog id
907 public function set_blog_id( $blog_id, $site_id = 0 ) {
908 if ( ! empty( $site_id ) )
909 $this->siteid = $site_id;
911 $old_blog_id = $this->blogid;
912 $this->blogid = $blog_id;
914 $this->prefix = $this->get_blog_prefix();
916 foreach ( $this->tables( 'blog' ) as $table => $prefixed_table )
917 $this->$table = $prefixed_table;
919 foreach ( $this->tables( 'old' ) as $table => $prefixed_table )
920 $this->$table = $prefixed_table;
929 * @param int $blog_id Optional.
930 * @return string Blog prefix.
932 public function get_blog_prefix( $blog_id = null ) {
933 if ( is_multisite() ) {
934 if ( null === $blog_id )
935 $blog_id = $this->blogid;
936 $blog_id = (int) $blog_id;
937 if ( defined( 'MULTISITE' ) && ( 0 == $blog_id || 1 == $blog_id ) )
938 return $this->base_prefix;
940 return $this->base_prefix . $blog_id . '_';
942 return $this->base_prefix;
947 * Returns an array of WordPress tables.
949 * Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
950 * override the WordPress users and usermeta tables that would otherwise
951 * be determined by the prefix.
953 * The scope argument can take one of the following:
955 * 'all' - returns 'all' and 'global' tables. No old tables are returned.
956 * 'blog' - returns the blog-level tables for the queried blog.
957 * 'global' - returns the global tables for the installation, returning multisite tables only if running multisite.
958 * 'ms_global' - returns the multisite global tables, regardless if current installation is multisite.
959 * 'old' - returns tables which are deprecated.
962 * @uses wpdb::$tables
963 * @uses wpdb::$old_tables
964 * @uses wpdb::$global_tables
965 * @uses wpdb::$ms_global_tables
967 * @param string $scope Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all.
968 * @param bool $prefix Optional. Whether to include table prefixes. Default true. If blog
969 * prefix is requested, then the custom users and usermeta tables will be mapped.
970 * @param int $blog_id Optional. The blog_id to prefix. Defaults to wpdb::$blogid. Used only when prefix is requested.
971 * @return array Table names. When a prefix is requested, the key is the unprefixed table name.
973 public function tables( $scope = 'all', $prefix = true, $blog_id = 0 ) {
976 $tables = array_merge( $this->global_tables, $this->tables );
977 if ( is_multisite() )
978 $tables = array_merge( $tables, $this->ms_global_tables );
981 $tables = $this->tables;
984 $tables = $this->global_tables;
985 if ( is_multisite() )
986 $tables = array_merge( $tables, $this->ms_global_tables );
989 $tables = $this->ms_global_tables;
992 $tables = $this->old_tables;
1000 $blog_id = $this->blogid;
1001 $blog_prefix = $this->get_blog_prefix( $blog_id );
1002 $base_prefix = $this->base_prefix;
1003 $global_tables = array_merge( $this->global_tables, $this->ms_global_tables );
1004 foreach ( $tables as $k => $table ) {
1005 if ( in_array( $table, $global_tables ) )
1006 $tables[ $table ] = $base_prefix . $table;
1008 $tables[ $table ] = $blog_prefix . $table;
1009 unset( $tables[ $k ] );
1012 if ( isset( $tables['users'] ) && defined( 'CUSTOM_USER_TABLE' ) )
1013 $tables['users'] = CUSTOM_USER_TABLE;
1015 if ( isset( $tables['usermeta'] ) && defined( 'CUSTOM_USER_META_TABLE' ) )
1016 $tables['usermeta'] = CUSTOM_USER_META_TABLE;
1023 * Selects a database using the current database connection.
1025 * The database name will be changed based on the current database
1026 * connection. On failure, the execution will bail and display an DB error.
1030 * @param string $db MySQL database name
1031 * @param resource|null $dbh Optional link identifier.
1033 public function select( $db, $dbh = null ) {
1034 if ( is_null($dbh) )
1037 if ( $this->use_mysqli ) {
1038 $success = @mysqli_select_db( $dbh, $db );
1040 $success = @mysql_select_db( $db, $dbh );
1043 $this->ready = false;
1044 if ( ! did_action( 'template_redirect' ) ) {
1045 wp_load_translations_early();
1046 $this->bail( sprintf( __( '<h1>Can’t select database</h1>
1047 <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>
1049 <li>Are you sure it exists?</li>
1050 <li>Does the user <code>%2$s</code> have permission to use the <code>%1$s</code> database?</li>
1051 <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>
1053 <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="https://wordpress.org/support/">WordPress Support Forums</a>.</p>' ), htmlspecialchars( $db, ENT_QUOTES ), htmlspecialchars( $this->dbuser, ENT_QUOTES ) ), 'db_select_fail' );
1059 * Do not use, deprecated.
1061 * Use esc_sql() or wpdb::prepare() instead.
1065 * @see wpdb::prepare
1069 * @param string $string
1072 function _weak_escape( $string ) {
1073 if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) )
1074 _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' );
1075 return addslashes( $string );
1079 * Real escape, using mysqli_real_escape_string() or mysql_real_escape_string()
1081 * @see mysqli_real_escape_string()
1082 * @see mysql_real_escape_string()
1086 * @param string $string to escape
1087 * @return string escaped
1089 function _real_escape( $string ) {
1091 if ( $this->use_mysqli ) {
1092 return mysqli_real_escape_string( $this->dbh, $string );
1094 return mysql_real_escape_string( $string, $this->dbh );
1098 $class = get_class( $this );
1099 if ( function_exists( '__' ) ) {
1100 _doing_it_wrong( $class, sprintf( __( '%s must set a database connection for use with escaping.' ), $class ), E_USER_NOTICE );
1102 _doing_it_wrong( $class, sprintf( '%s must set a database connection for use with escaping.', $class ), E_USER_NOTICE );
1104 return addslashes( $string );
1108 * Escape data. Works on arrays.
1110 * @uses wpdb::_real_escape()
1114 * @param string|array $data
1115 * @return string|array escaped
1117 function _escape( $data ) {
1118 if ( is_array( $data ) ) {
1119 foreach ( $data as $k => $v ) {
1121 $data[$k] = $this->_escape( $v );
1123 $data[$k] = $this->_real_escape( $v );
1126 $data = $this->_real_escape( $data );
1133 * Do not use, deprecated.
1135 * Use esc_sql() or wpdb::prepare() instead.
1139 * @see wpdb::prepare()
1142 * @param mixed $data
1145 public function escape( $data ) {
1146 if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) )
1147 _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' );
1148 if ( is_array( $data ) ) {
1149 foreach ( $data as $k => $v ) {
1150 if ( is_array( $v ) )
1151 $data[$k] = $this->escape( $v, 'recursive' );
1153 $data[$k] = $this->_weak_escape( $v, 'internal' );
1156 $data = $this->_weak_escape( $data, 'internal' );
1163 * Escapes content by reference for insertion into the database, for security
1165 * @uses wpdb::_real_escape()
1169 * @param string $string to escape
1171 public function escape_by_ref( &$string ) {
1172 if ( ! is_float( $string ) )
1173 $string = $this->_real_escape( $string );
1177 * Prepares a SQL query for safe execution. Uses sprintf()-like syntax.
1179 * The following directives can be used in the query format string:
1183 * %% (literal percentage sign - no argument needed)
1185 * All of %d, %f, and %s are to be left unquoted in the query string and they need an argument passed for them.
1186 * Literals (%) as parts of the query must be properly written as %%.
1188 * This function only supports a small subset of the sprintf syntax; it only supports %d (integer), %f (float), and %s (string).
1189 * Does not support sign, padding, alignment, width or precision specifiers.
1190 * Does not support argument numbering/swapping.
1192 * May be called like {@link http://php.net/sprintf sprintf()} or like {@link http://php.net/vsprintf vsprintf()}.
1194 * Both %d and %s should be left unquoted in the query string.
1196 * wpdb::prepare( "SELECT * FROM `table` WHERE `column` = %s AND `field` = %d", 'foo', 1337 )
1197 * wpdb::prepare( "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo' );
1199 * @link http://php.net/sprintf Description of syntax.
1202 * @param string $query Query statement with sprintf()-like placeholders
1203 * @param array|mixed $args The array of variables to substitute into the query's placeholders if being called like
1204 * {@link http://php.net/vsprintf vsprintf()}, or the first variable to substitute into the query's placeholders if
1205 * being called like {@link http://php.net/sprintf sprintf()}.
1206 * @param mixed $args,... further variables to substitute into the query's placeholders if being called like
1207 * {@link http://php.net/sprintf sprintf()}.
1208 * @return string|void Sanitized query string, if there is a query to prepare.
1210 public function prepare( $query, $args ) {
1211 if ( is_null( $query ) )
1214 // This is not meant to be foolproof -- but it will catch obviously incorrect usage.
1215 if ( strpos( $query, '%' ) === false ) {
1216 _doing_it_wrong( 'wpdb::prepare', sprintf( __( 'The query argument of %s must have a placeholder.' ), 'wpdb::prepare()' ), '3.9' );
1219 $args = func_get_args();
1220 array_shift( $args );
1221 // If args were passed as an array (as in vsprintf), move them up
1222 if ( isset( $args[0] ) && is_array($args[0]) )
1224 $query = str_replace( "'%s'", '%s', $query ); // in case someone mistakenly already singlequoted it
1225 $query = str_replace( '"%s"', '%s', $query ); // doublequote unquoting
1226 $query = preg_replace( '|(?<!%)%f|' , '%F', $query ); // Force floats to be locale unaware
1227 $query = preg_replace( '|(?<!%)%s|', "'%s'", $query ); // quote the strings, avoiding escaped strings like %%s
1228 array_walk( $args, array( $this, 'escape_by_ref' ) );
1229 return @vsprintf( $query, $args );
1233 * First half of escaping for LIKE special characters % and _ before preparing for MySQL.
1235 * Use this only before wpdb::prepare() or esc_sql(). Reversing the order is very bad for security.
1237 * Example Prepared Statement:
1239 * $find = 'only 43% of planets';
1240 * $like = $wild . $wpdb->esc_like( $find ) . $wild;
1241 * $sql = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE %s", $like );
1243 * Example Escape Chain:
1244 * $sql = esc_sql( $wpdb->esc_like( $input ) );
1249 * @param string $text The raw text to be escaped. The input typed by the user should have no
1250 * extra or deleted slashes.
1251 * @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call $wpdb::prepare()
1252 * or real_escape next.
1254 public function esc_like( $text ) {
1255 return addcslashes( $text, '_%\\' );
1259 * Print SQL/DB error.
1262 * @global array $EZSQL_ERROR Stores error information of query and error string
1264 * @param string $str The error to display
1265 * @return false|void False if the showing of errors is disabled.
1267 public function print_error( $str = '' ) {
1268 global $EZSQL_ERROR;
1271 if ( $this->use_mysqli ) {
1272 $str = mysqli_error( $this->dbh );
1274 $str = mysql_error( $this->dbh );
1277 $EZSQL_ERROR[] = array( 'query' => $this->last_query, 'error_str' => $str );
1279 if ( $this->suppress_errors )
1282 wp_load_translations_early();
1284 if ( $caller = $this->get_caller() )
1285 $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s made by %3$s' ), $str, $this->last_query, $caller );
1287 $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s' ), $str, $this->last_query );
1289 error_log( $error_str );
1291 // Are we showing errors?
1292 if ( ! $this->show_errors )
1295 // If there is an error then take note of it
1296 if ( is_multisite() ) {
1299 __( 'WordPress database error:' ),
1304 if ( defined( 'ERRORLOGFILE' ) ) {
1305 error_log( $msg, 3, ERRORLOGFILE );
1307 if ( defined( 'DIEONDBERROR' ) ) {
1311 $str = htmlspecialchars( $str, ENT_QUOTES );
1312 $query = htmlspecialchars( $this->last_query, ENT_QUOTES );
1315 '<div id="error"><p class="wpdberror"><strong>%s</strong> [%s]<br /><code>%s</code></p></div>',
1316 __( 'WordPress database error:' ),
1324 * Enables showing of database errors.
1326 * This function should be used only to enable showing of errors.
1327 * wpdb::hide_errors() should be used instead for hiding of errors. However,
1328 * this function can be used to enable and disable showing of database
1332 * @see wpdb::hide_errors()
1334 * @param bool $show Whether to show or hide errors
1335 * @return bool Old value for showing errors.
1337 public function show_errors( $show = true ) {
1338 $errors = $this->show_errors;
1339 $this->show_errors = $show;
1344 * Disables showing of database errors.
1346 * By default database errors are not shown.
1349 * @see wpdb::show_errors()
1351 * @return bool Whether showing of errors was active
1353 public function hide_errors() {
1354 $show = $this->show_errors;
1355 $this->show_errors = false;
1360 * Whether to suppress database errors.
1362 * By default database errors are suppressed, with a simple
1363 * call to this function they can be enabled.
1366 * @see wpdb::hide_errors()
1367 * @param bool $suppress Optional. New value. Defaults to true.
1368 * @return bool Old value
1370 public function suppress_errors( $suppress = true ) {
1371 $errors = $this->suppress_errors;
1372 $this->suppress_errors = (bool) $suppress;
1377 * Kill cached query results.
1381 public function flush() {
1382 $this->last_result = array();
1383 $this->col_info = null;
1384 $this->last_query = null;
1385 $this->rows_affected = $this->num_rows = 0;
1386 $this->last_error = '';
1388 if ( $this->use_mysqli && $this->result instanceof mysqli_result ) {
1389 mysqli_free_result( $this->result );
1390 $this->result = null;
1392 // Sanity check before using the handle
1393 if ( empty( $this->dbh ) || !( $this->dbh instanceof mysqli ) ) {
1397 // Clear out any results from a multi-query
1398 while ( mysqli_more_results( $this->dbh ) ) {
1399 mysqli_next_result( $this->dbh );
1401 } elseif ( is_resource( $this->result ) ) {
1402 mysql_free_result( $this->result );
1407 * Connect to and select database.
1409 * If $allow_bail is false, the lack of database connection will need
1410 * to be handled manually.
1413 * @since 3.9.0 $allow_bail parameter added.
1415 * @param bool $allow_bail Optional. Allows the function to bail. Default true.
1416 * @return bool True with a successful connection, false on failure.
1418 public function db_connect( $allow_bail = true ) {
1419 $this->is_mysql = true;
1422 * Deprecated in 3.9+ when using MySQLi. No equivalent
1423 * $new_link parameter exists for mysqli_* functions.
1425 $new_link = defined( 'MYSQL_NEW_LINK' ) ? MYSQL_NEW_LINK : true;
1426 $client_flags = defined( 'MYSQL_CLIENT_FLAGS' ) ? MYSQL_CLIENT_FLAGS : 0;
1428 if ( $this->use_mysqli ) {
1429 $this->dbh = mysqli_init();
1431 // mysqli_real_connect doesn't support the host param including a port or socket
1432 // like mysql_connect does. This duplicates how mysql_connect detects a port and/or socket file.
1435 $host = $this->dbhost;
1436 $port_or_socket = strstr( $host, ':' );
1437 if ( ! empty( $port_or_socket ) ) {
1438 $host = substr( $host, 0, strpos( $host, ':' ) );
1439 $port_or_socket = substr( $port_or_socket, 1 );
1440 if ( 0 !== strpos( $port_or_socket, '/' ) ) {
1441 $port = intval( $port_or_socket );
1442 $maybe_socket = strstr( $port_or_socket, ':' );
1443 if ( ! empty( $maybe_socket ) ) {
1444 $socket = substr( $maybe_socket, 1 );
1447 $socket = $port_or_socket;
1452 mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
1454 @mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
1457 if ( $this->dbh->connect_errno ) {
1460 /* It's possible ext/mysqli is misconfigured. Fall back to ext/mysql if:
1461 * - We haven't previously connected, and
1462 * - WP_USE_EXT_MYSQL isn't set to false, and
1463 * - ext/mysql is loaded.
1465 $attempt_fallback = true;
1467 if ( $this->has_connected ) {
1468 $attempt_fallback = false;
1469 } elseif ( defined( 'WP_USE_EXT_MYSQL' ) && ! WP_USE_EXT_MYSQL ) {
1470 $attempt_fallback = false;
1471 } elseif ( ! function_exists( 'mysql_connect' ) ) {
1472 $attempt_fallback = false;
1475 if ( $attempt_fallback ) {
1476 $this->use_mysqli = false;
1477 $this->db_connect();
1482 $this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
1484 $this->dbh = @mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
1488 if ( ! $this->dbh && $allow_bail ) {
1489 wp_load_translations_early();
1491 // Load custom DB error template, if present.
1492 if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
1493 require_once( WP_CONTENT_DIR . '/db-error.php' );
1497 $this->bail( sprintf( __( "
1498 <h1>Error establishing a database connection</h1>
1499 <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>
1501 <li>Are you sure you have the correct username and password?</li>
1502 <li>Are you sure that you have typed the correct hostname?</li>
1503 <li>Are you sure that the database server is running?</li>
1505 <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='https://wordpress.org/support/'>WordPress Support Forums</a>.</p>
1506 " ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' );
1509 } elseif ( $this->dbh ) {
1510 if ( ! $this->has_connected ) {
1511 $this->init_charset();
1514 $this->has_connected = true;
1516 $this->set_charset( $this->dbh );
1518 $this->ready = true;
1519 $this->set_sql_mode();
1520 $this->select( $this->dbname, $this->dbh );
1529 * Check that the connection to the database is still up. If not, try to reconnect.
1531 * If this function is unable to reconnect, it will forcibly die, or if after the
1532 * the template_redirect hook has been fired, return false instead.
1534 * If $allow_bail is false, the lack of database connection will need
1535 * to be handled manually.
1539 * @param bool $allow_bail Optional. Allows the function to bail. Default true.
1540 * @return bool|void True if the connection is up.
1542 public function check_connection( $allow_bail = true ) {
1543 if ( $this->use_mysqli ) {
1544 if ( @mysqli_ping( $this->dbh ) ) {
1548 if ( @mysql_ping( $this->dbh ) ) {
1553 $error_reporting = false;
1555 // Disable warnings, as we don't want to see a multitude of "unable to connect" messages
1557 $error_reporting = error_reporting();
1558 error_reporting( $error_reporting & ~E_WARNING );
1561 for ( $tries = 1; $tries <= $this->reconnect_retries; $tries++ ) {
1562 // On the last try, re-enable warnings. We want to see a single instance of the
1563 // "unable to connect" message on the bail() screen, if it appears.
1564 if ( $this->reconnect_retries === $tries && WP_DEBUG ) {
1565 error_reporting( $error_reporting );
1568 if ( $this->db_connect( false ) ) {
1569 if ( $error_reporting ) {
1570 error_reporting( $error_reporting );
1579 // If template_redirect has already happened, it's too late for wp_die()/dead_db().
1580 // Let's just return and hope for the best.
1581 if ( did_action( 'template_redirect' ) ) {
1585 if ( ! $allow_bail ) {
1589 // We weren't able to reconnect, so we better bail.
1590 $this->bail( sprintf( ( "
1591 <h1>Error reconnecting to the database</h1>
1592 <p>This means that we lost contact with the database server at <code>%s</code>. This could mean your host's database server is down.</p>
1594 <li>Are you sure that the database server is running?</li>
1595 <li>Are you sure that the database server is not under particularly heavy load?</li>
1597 <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='https://wordpress.org/support/'>WordPress Support Forums</a>.</p>
1598 " ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' );
1600 // Call dead_db() if bail didn't die, because this database is no more. It has ceased to be (at least temporarily).
1605 * Perform a MySQL database query, using current database connection.
1607 * More information can be found on the codex page.
1611 * @param string $query Database query
1612 * @return int|false Number of rows affected/selected or false on error
1614 public function query( $query ) {
1615 if ( ! $this->ready ) {
1616 $this->check_current_query = true;
1621 * Filter the database query.
1623 * Some queries are made before the plugins have been loaded,
1624 * and thus cannot be filtered with this method.
1628 * @param string $query Database query.
1630 $query = apply_filters( 'query', $query );
1634 // Log how the function was called
1635 $this->func_call = "\$db->query(\"$query\")";
1637 // If we're writing to the database, make sure the query will write safely.
1638 if ( $this->check_current_query && ! $this->check_ascii( $query ) ) {
1639 $stripped_query = $this->strip_invalid_text_from_query( $query );
1640 // strip_invalid_text_from_query() can perform queries, so we need
1641 // to flush again, just to make sure everything is clear.
1643 if ( $stripped_query !== $query ) {
1644 $this->insert_id = 0;
1649 $this->check_current_query = true;
1651 // Keep track of the last query for debug..
1652 $this->last_query = $query;
1654 $this->_do_query( $query );
1656 // MySQL server has gone away, try to reconnect
1658 if ( ! empty( $this->dbh ) ) {
1659 if ( $this->use_mysqli ) {
1660 $mysql_errno = mysqli_errno( $this->dbh );
1662 $mysql_errno = mysql_errno( $this->dbh );
1666 if ( empty( $this->dbh ) || 2006 == $mysql_errno ) {
1667 if ( $this->check_connection() ) {
1668 $this->_do_query( $query );
1670 $this->insert_id = 0;
1675 // If there is an error then take note of it..
1676 if ( $this->use_mysqli ) {
1677 $this->last_error = mysqli_error( $this->dbh );
1679 $this->last_error = mysql_error( $this->dbh );
1682 if ( $this->last_error ) {
1683 // Clear insert_id on a subsequent failed insert.
1684 if ( $this->insert_id && preg_match( '/^\s*(insert|replace)\s/i', $query ) )
1685 $this->insert_id = 0;
1687 $this->print_error();
1691 if ( preg_match( '/^\s*(create|alter|truncate|drop)\s/i', $query ) ) {
1692 $return_val = $this->result;
1693 } elseif ( preg_match( '/^\s*(insert|delete|update|replace)\s/i', $query ) ) {
1694 if ( $this->use_mysqli ) {
1695 $this->rows_affected = mysqli_affected_rows( $this->dbh );
1697 $this->rows_affected = mysql_affected_rows( $this->dbh );
1699 // Take note of the insert_id
1700 if ( preg_match( '/^\s*(insert|replace)\s/i', $query ) ) {
1701 if ( $this->use_mysqli ) {
1702 $this->insert_id = mysqli_insert_id( $this->dbh );
1704 $this->insert_id = mysql_insert_id( $this->dbh );
1707 // Return number of rows affected
1708 $return_val = $this->rows_affected;
1711 if ( $this->use_mysqli && $this->result instanceof mysqli_result ) {
1712 while ( $row = @mysqli_fetch_object( $this->result ) ) {
1713 $this->last_result[$num_rows] = $row;
1716 } elseif ( is_resource( $this->result ) ) {
1717 while ( $row = @mysql_fetch_object( $this->result ) ) {
1718 $this->last_result[$num_rows] = $row;
1723 // Log number of rows the query returned
1724 // and return number of rows selected
1725 $this->num_rows = $num_rows;
1726 $return_val = $num_rows;
1733 * Internal function to perform the mysql_query() call.
1738 * @see wpdb::query()
1740 * @param string $query The query to run.
1742 private function _do_query( $query ) {
1743 if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) {
1744 $this->timer_start();
1747 if ( $this->use_mysqli ) {
1748 $this->result = @mysqli_query( $this->dbh, $query );
1750 $this->result = @mysql_query( $query, $this->dbh );
1752 $this->num_queries++;
1754 if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) {
1755 $this->queries[] = array( $query, $this->timer_stop(), $this->get_caller() );
1760 * Insert a row into a table.
1762 * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
1763 * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
1766 * @see wpdb::prepare()
1767 * @see wpdb::$field_types
1768 * @see wp_set_wpdb_vars()
1770 * @param string $table Table name
1771 * @param array $data Data to insert (in column => value pairs).
1772 * Both $data columns and $data values should be "raw" (neither should be SQL escaped).
1773 * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
1774 * If string, that format will be used for all of the values in $data.
1775 * A format is one of '%d', '%f', '%s' (integer, float, string).
1776 * If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
1777 * @return int|false The number of rows inserted, or false on error.
1779 public function insert( $table, $data, $format = null ) {
1780 return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' );
1784 * Replace a row into a table.
1786 * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
1787 * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
1790 * @see wpdb::prepare()
1791 * @see wpdb::$field_types
1792 * @see wp_set_wpdb_vars()
1794 * @param string $table Table name
1795 * @param array $data Data to insert (in column => value pairs).
1796 * Both $data columns and $data values should be "raw" (neither should be SQL escaped).
1797 * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
1798 * If string, that format will be used for all of the values in $data.
1799 * A format is one of '%d', '%f', '%s' (integer, float, string).
1800 * If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
1801 * @return int|false The number of rows affected, or false on error.
1803 public function replace( $table, $data, $format = null ) {
1804 return $this->_insert_replace_helper( $table, $data, $format, 'REPLACE' );
1808 * Helper function for insert and replace.
1810 * Runs an insert or replace query based on $type argument.
1814 * @see wpdb::prepare()
1815 * @see wpdb::$field_types
1816 * @see wp_set_wpdb_vars()
1818 * @param string $table Table name
1819 * @param array $data Data to insert (in column => value pairs).
1820 * Both $data columns and $data values should be "raw" (neither should be SQL escaped).
1821 * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
1822 * If string, that format will be used for all of the values in $data.
1823 * A format is one of '%d', '%f', '%s' (integer, float, string).
1824 * If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
1825 * @param string $type Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT.
1826 * @return int|false The number of rows affected, or false on error.
1828 function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {
1829 $this->insert_id = 0;
1831 if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ) ) ) {
1835 $data = $this->process_fields( $table, $data, $format );
1836 if ( false === $data ) {
1840 $formats = $values = array();
1841 foreach ( $data as $value ) {
1842 $formats[] = $value['format'];
1843 $values[] = $value['value'];
1846 $fields = '`' . implode( '`, `', array_keys( $data ) ) . '`';
1847 $formats = implode( ', ', $formats );
1849 $sql = "$type INTO `$table` ($fields) VALUES ($formats)";
1851 $this->check_current_query = false;
1852 return $this->query( $this->prepare( $sql, $values ) );
1856 * Update a row in the table
1858 * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 'bar' ), array( 'ID' => 1 ) )
1859 * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) )
1862 * @see wpdb::prepare()
1863 * @see wpdb::$field_types
1864 * @see wp_set_wpdb_vars()
1866 * @param string $table Table name
1867 * @param array $data Data to update (in column => value pairs).
1868 * Both $data columns and $data values should be "raw" (neither should be SQL escaped).
1869 * @param array $where A named array of WHERE clauses (in column => value pairs).
1870 * Multiple clauses will be joined with ANDs.
1871 * Both $where columns and $where values should be "raw".
1872 * @param array|string $format Optional. An array of formats to be mapped to each of the values in $data.
1873 * If string, that format will be used for all of the values in $data.
1874 * A format is one of '%d', '%f', '%s' (integer, float, string).
1875 * If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
1876 * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where.
1877 * If string, that format will be used for all of the items in $where.
1878 * A format is one of '%d', '%f', '%s' (integer, float, string).
1879 * If omitted, all values in $where will be treated as strings.
1880 * @return int|false The number of rows updated, or false on error.
1882 public function update( $table, $data, $where, $format = null, $where_format = null ) {
1883 if ( ! is_array( $data ) || ! is_array( $where ) ) {
1887 $data = $this->process_fields( $table, $data, $format );
1888 if ( false === $data ) {
1891 $where = $this->process_fields( $table, $where, $where_format );
1892 if ( false === $where ) {
1896 $fields = $conditions = $values = array();
1897 foreach ( $data as $field => $value ) {
1898 $fields[] = "`$field` = " . $value['format'];
1899 $values[] = $value['value'];
1901 foreach ( $where as $field => $value ) {
1902 $conditions[] = "`$field` = " . $value['format'];
1903 $values[] = $value['value'];
1906 $fields = implode( ', ', $fields );
1907 $conditions = implode( ' AND ', $conditions );
1909 $sql = "UPDATE `$table` SET $fields WHERE $conditions";
1911 $this->check_current_query = false;
1912 return $this->query( $this->prepare( $sql, $values ) );
1916 * Delete a row in the table
1918 * wpdb::delete( 'table', array( 'ID' => 1 ) )
1919 * wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) )
1922 * @see wpdb::prepare()
1923 * @see wpdb::$field_types
1924 * @see wp_set_wpdb_vars()
1926 * @param string $table Table name
1927 * @param array $where A named array of WHERE clauses (in column => value pairs).
1928 * Multiple clauses will be joined with ANDs.
1929 * Both $where columns and $where values should be "raw".
1930 * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where.
1931 * If string, that format will be used for all of the items in $where.
1932 * A format is one of '%d', '%f', '%s' (integer, float, string).
1933 * If omitted, all values in $where will be treated as strings unless otherwise specified in wpdb::$field_types.
1934 * @return int|false The number of rows updated, or false on error.
1936 public function delete( $table, $where, $where_format = null ) {
1937 if ( ! is_array( $where ) ) {
1941 $where = $this->process_fields( $table, $where, $where_format );
1942 if ( false === $where ) {
1946 $conditions = $values = array();
1947 foreach ( $where as $field => $value ) {
1948 $conditions[] = "`$field` = " . $value['format'];
1949 $values[] = $value['value'];
1952 $conditions = implode( ' AND ', $conditions );
1954 $sql = "DELETE FROM `$table` WHERE $conditions";
1956 $this->check_current_query = false;
1957 return $this->query( $this->prepare( $sql, $values ) );
1961 * Processes arrays of field/value pairs and field formats.
1963 * This is a helper method for wpdb's CRUD methods, which take field/value
1964 * pairs for inserts, updates, and where clauses. This method first pairs
1965 * each value with a format. Then it determines the charset of that field,
1966 * using that to determine if any invalid text would be stripped. If text is
1967 * stripped, then field processing is rejected and the query fails.
1972 * @param string $table Table name.
1973 * @param array $data Field/value pair.
1974 * @param mixed $format Format for each field.
1975 * @return array|false Returns an array of fields that contain paired values
1976 * and formats. Returns false for invalid values.
1978 protected function process_fields( $table, $data, $format ) {
1979 $data = $this->process_field_formats( $data, $format );
1980 if ( false === $data ) {
1984 $data = $this->process_field_charsets( $data, $table );
1985 if ( false === $data ) {
1989 $data = $this->process_field_lengths( $data, $table );
1990 if ( false === $data ) {
1994 $converted_data = $this->strip_invalid_text( $data );
1996 if ( $data !== $converted_data ) {
2004 * Prepares arrays of value/format pairs as passed to wpdb CRUD methods.
2009 * @param array $data Array of fields to values.
2010 * @param mixed $format Formats to be mapped to the values in $data.
2011 * @return array Array, keyed by field names with values being an array
2012 * of 'value' and 'format' keys.
2014 protected function process_field_formats( $data, $format ) {
2015 $formats = $original_formats = (array) $format;
2017 foreach ( $data as $field => $value ) {
2023 if ( ! empty( $format ) ) {
2024 $value['format'] = array_shift( $formats );
2025 if ( ! $value['format'] ) {
2026 $value['format'] = reset( $original_formats );
2028 } elseif ( isset( $this->field_types[ $field ] ) ) {
2029 $value['format'] = $this->field_types[ $field ];
2032 $data[ $field ] = $value;
2039 * Adds field charsets to field/value/format arrays generated by
2040 * the wpdb::process_field_formats() method.
2045 * @param array $data As it comes from the wpdb::process_field_formats() method.
2046 * @param string $table Table name.
2047 * @return array|false The same array as $data with additional 'charset' keys.
2049 protected function process_field_charsets( $data, $table ) {
2050 foreach ( $data as $field => $value ) {
2051 if ( '%d' === $value['format'] || '%f' === $value['format'] ) {
2052 // We can skip this field if we know it isn't a string.
2053 // This checks %d/%f versus ! %s because it's sprintf() could take more.
2054 $value['charset'] = false;
2056 $value['charset'] = $this->get_col_charset( $table, $field );
2057 if ( is_wp_error( $value['charset'] ) ) {
2062 $data[ $field ] = $value;
2069 * For string fields, record the maximum string length that field can safely save.
2074 * @param array $data As it comes from the wpdb::process_field_charsets() method.
2075 * @param string $table Table name.
2076 * @return array|false The same array as $data with additional 'length' keys, or false if
2077 * any of the values were too long for their corresponding field.
2079 protected function process_field_lengths( $data, $table ) {
2080 foreach ( $data as $field => $value ) {
2081 if ( '%d' === $value['format'] || '%f' === $value['format'] ) {
2082 // We can skip this field if we know it isn't a string.
2083 // This checks %d/%f versus ! %s because it's sprintf() could take more.
2084 $value['length'] = false;
2086 $value['length'] = $this->get_col_length( $table, $field );
2087 if ( is_wp_error( $value['length'] ) ) {
2092 $data[ $field ] = $value;
2099 * Retrieve one variable from the database.
2101 * Executes a SQL query and returns the value from the SQL result.
2102 * 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.
2103 * If $query is null, this function returns the value in the specified column and row from the previous SQL result.
2107 * @param string|null $query Optional. SQL query. Defaults to null, use the result from the previous query.
2108 * @param int $x Optional. Column of value to return. Indexed from 0.
2109 * @param int $y Optional. Row of value to return. Indexed from 0.
2110 * @return string|null Database query result (as string), or null on failure
2112 public function get_var( $query = null, $x = 0, $y = 0 ) {
2113 $this->func_call = "\$db->get_var(\"$query\", $x, $y)";
2115 if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
2116 $this->check_current_query = false;
2120 $this->query( $query );
2123 // Extract var out of cached results based x,y vals
2124 if ( !empty( $this->last_result[$y] ) ) {
2125 $values = array_values( get_object_vars( $this->last_result[$y] ) );
2128 // If there is a value return it else return null
2129 return ( isset( $values[$x] ) && $values[$x] !== '' ) ? $values[$x] : null;
2133 * Retrieve one row from the database.
2135 * Executes a SQL query and returns the row from the SQL result.
2139 * @param string|null $query SQL query.
2140 * @param string $output Optional. one of ARRAY_A | ARRAY_N | OBJECT constants.
2141 * Return an associative array (column => value, ...),
2142 * a numerically indexed array (0 => value, ...) or
2143 * an object ( ->column = value ), respectively.
2144 * @param int $y Optional. Row to return. Indexed from 0.
2145 * @return array|object|null|void Database query result in format specified by $output or null on failure
2147 public function get_row( $query = null, $output = OBJECT, $y = 0 ) {
2148 $this->func_call = "\$db->get_row(\"$query\",$output,$y)";
2150 if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
2151 $this->check_current_query = false;
2155 $this->query( $query );
2160 if ( !isset( $this->last_result[$y] ) )
2163 if ( $output == OBJECT ) {
2164 return $this->last_result[$y] ? $this->last_result[$y] : null;
2165 } elseif ( $output == ARRAY_A ) {
2166 return $this->last_result[$y] ? get_object_vars( $this->last_result[$y] ) : null;
2167 } elseif ( $output == ARRAY_N ) {
2168 return $this->last_result[$y] ? array_values( get_object_vars( $this->last_result[$y] ) ) : null;
2169 } elseif ( strtoupper( $output ) === OBJECT ) {
2170 // Back compat for OBJECT being previously case insensitive.
2171 return $this->last_result[$y] ? $this->last_result[$y] : null;
2173 $this->print_error( " \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N" );
2178 * Retrieve one column from the database.
2180 * Executes a SQL query and returns the column from the SQL result.
2181 * If the SQL result contains more than one column, this function returns the column specified.
2182 * If $query is null, this function returns the specified column from the previous SQL result.
2186 * @param string|null $query Optional. SQL query. Defaults to previous query.
2187 * @param int $x Optional. Column to return. Indexed from 0.
2188 * @return array Database query result. Array indexed from 0 by SQL result row number.
2190 public function get_col( $query = null , $x = 0 ) {
2191 if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
2192 $this->check_current_query = false;
2196 $this->query( $query );
2199 $new_array = array();
2200 // Extract the column values
2201 for ( $i = 0, $j = count( $this->last_result ); $i < $j; $i++ ) {
2202 $new_array[$i] = $this->get_var( null, $x, $i );
2208 * Retrieve an entire SQL result set from the database (i.e., many rows)
2210 * Executes a SQL query and returns the entire SQL result.
2214 * @param string $query SQL query.
2215 * @param string $output Optional. Any of ARRAY_A | ARRAY_N | OBJECT | OBJECT_K constants.
2216 * With one of the first three, return an array of rows indexed from 0 by SQL result row number.
2217 * Each row is an associative array (column => value, ...), a numerically indexed array (0 => value, ...), or an object. ( ->column = value ), respectively.
2218 * With OBJECT_K, return an associative array of row objects keyed by the value of each row's first column's value.
2219 * Duplicate keys are discarded.
2220 * @return array|object|null Database query results
2222 public function get_results( $query = null, $output = OBJECT ) {
2223 $this->func_call = "\$db->get_results(\"$query\", $output)";
2225 if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
2226 $this->check_current_query = false;
2230 $this->query( $query );
2235 $new_array = array();
2236 if ( $output == OBJECT ) {
2237 // Return an integer-keyed array of row objects
2238 return $this->last_result;
2239 } elseif ( $output == OBJECT_K ) {
2240 // Return an array of row objects with keys from column 1
2241 // (Duplicates are discarded)
2242 foreach ( $this->last_result as $row ) {
2243 $var_by_ref = get_object_vars( $row );
2244 $key = array_shift( $var_by_ref );
2245 if ( ! isset( $new_array[ $key ] ) )
2246 $new_array[ $key ] = $row;
2249 } elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
2250 // Return an integer-keyed array of...
2251 if ( $this->last_result ) {
2252 foreach( (array) $this->last_result as $row ) {
2253 if ( $output == ARRAY_N ) {
2254 // ...integer-keyed row arrays
2255 $new_array[] = array_values( get_object_vars( $row ) );
2257 // ...column name-keyed row arrays
2258 $new_array[] = get_object_vars( $row );
2263 } elseif ( strtoupper( $output ) === OBJECT ) {
2264 // Back compat for OBJECT being previously case insensitive.
2265 return $this->last_result;
2271 * Retrieves the character set for the given table.
2276 * @param string $table Table name.
2277 * @return string|WP_Error Table character set, WP_Error object if it couldn't be found.
2279 protected function get_table_charset( $table ) {
2280 $tablekey = strtolower( $table );
2283 * Filter the table charset value before the DB is checked.
2285 * Passing a non-null value to the filter will effectively short-circuit
2286 * checking the DB for the charset, returning that value instead.
2290 * @param string $charset The character set to use. Default null.
2291 * @param string $table The name of the table being checked.
2293 $charset = apply_filters( 'pre_get_table_charset', null, $table );
2294 if ( null !== $charset ) {
2298 if ( isset( $this->table_charset[ $tablekey ] ) ) {
2299 return $this->table_charset[ $tablekey ];
2302 $charsets = $columns = array();
2304 $table_parts = explode( '.', $table );
2305 $table = '`' . implode( '`.`', $table_parts ) . '`';
2306 $results = $this->get_results( "SHOW FULL COLUMNS FROM $table" );
2308 return new WP_Error( 'wpdb_get_table_charset_failure' );
2311 foreach ( $results as $column ) {
2312 $columns[ strtolower( $column->Field ) ] = $column;
2315 $this->col_meta[ $tablekey ] = $columns;
2317 foreach ( $columns as $column ) {
2318 if ( ! empty( $column->Collation ) ) {
2319 list( $charset ) = explode( '_', $column->Collation );
2321 // If the current connection can't support utf8mb4 characters, let's only send 3-byte utf8 characters.
2322 if ( 'utf8mb4' === $charset && ! $this->has_cap( 'utf8mb4' ) ) {
2326 $charsets[ strtolower( $charset ) ] = true;
2329 list( $type ) = explode( '(', $column->Type );
2331 // A binary/blob means the whole query gets treated like this.
2332 if ( in_array( strtoupper( $type ), array( 'BINARY', 'VARBINARY', 'TINYBLOB', 'MEDIUMBLOB', 'BLOB', 'LONGBLOB' ) ) ) {
2333 $this->table_charset[ $tablekey ] = 'binary';
2338 // utf8mb3 is an alias for utf8.
2339 if ( isset( $charsets['utf8mb3'] ) ) {
2340 $charsets['utf8'] = true;
2341 unset( $charsets['utf8mb3'] );
2344 // Check if we have more than one charset in play.
2345 $count = count( $charsets );
2346 if ( 1 === $count ) {
2347 $charset = key( $charsets );
2348 } elseif ( 0 === $count ) {
2349 // No charsets, assume this table can store whatever.
2352 // More than one charset. Remove latin1 if present and recalculate.
2353 unset( $charsets['latin1'] );
2354 $count = count( $charsets );
2355 if ( 1 === $count ) {
2356 // Only one charset (besides latin1).
2357 $charset = key( $charsets );
2358 } elseif ( 2 === $count && isset( $charsets['utf8'], $charsets['utf8mb4'] ) ) {
2359 // Two charsets, but they're utf8 and utf8mb4, use utf8.
2362 // Two mixed character sets. ascii.
2367 $this->table_charset[ $tablekey ] = $charset;
2372 * Retrieves the character set for the given column.
2377 * @param string $table Table name.
2378 * @param string $column Column name.
2379 * @return string|false|WP_Error Column character set as a string. False if the column has no
2380 * character set. WP_Error object if there was an error.
2382 public function get_col_charset( $table, $column ) {
2383 $tablekey = strtolower( $table );
2384 $columnkey = strtolower( $column );
2387 * Filter the column charset value before the DB is checked.
2389 * Passing a non-null value to the filter will short-circuit
2390 * checking the DB for the charset, returning that value instead.
2394 * @param string $charset The character set to use. Default null.
2395 * @param string $table The name of the table being checked.
2396 * @param string $column The name of the column being checked.
2398 $charset = apply_filters( 'pre_get_col_charset', null, $table, $column );
2399 if ( null !== $charset ) {
2403 // Skip this entirely if this isn't a MySQL database.
2404 if ( false === $this->is_mysql ) {
2408 if ( empty( $this->table_charset[ $tablekey ] ) ) {
2409 // This primes column information for us.
2410 $table_charset = $this->get_table_charset( $table );
2411 if ( is_wp_error( $table_charset ) ) {
2412 return $table_charset;
2416 // If still no column information, return the table charset.
2417 if ( empty( $this->col_meta[ $tablekey ] ) ) {
2418 return $this->table_charset[ $tablekey ];
2421 // If this column doesn't exist, return the table charset.
2422 if ( empty( $this->col_meta[ $tablekey ][ $columnkey ] ) ) {
2423 return $this->table_charset[ $tablekey ];
2426 // Return false when it's not a string column.
2427 if ( empty( $this->col_meta[ $tablekey ][ $columnkey ]->Collation ) ) {
2431 list( $charset ) = explode( '_', $this->col_meta[ $tablekey ][ $columnkey ]->Collation );
2436 * Retrieve the maximum string length allowed in a given column.
2437 * The length may either be specified as a byte length or a character length.
2442 * @param string $table Table name.
2443 * @param string $column Column name.
2444 * @return array|false|WP_Error array( 'length' => (int), 'type' => 'byte' | 'char' )
2445 * false if the column has no length (for example, numeric column)
2446 * WP_Error object if there was an error.
2448 public function get_col_length( $table, $column ) {
2449 $tablekey = strtolower( $table );
2450 $columnkey = strtolower( $column );
2452 // Skip this entirely if this isn't a MySQL database.
2453 if ( false === $this->is_mysql ) {
2457 if ( empty( $this->col_meta[ $tablekey ] ) ) {
2458 // This primes column information for us.
2459 $table_charset = $this->get_table_charset( $table );
2460 if ( is_wp_error( $table_charset ) ) {
2461 return $table_charset;
2465 if ( empty( $this->col_meta[ $tablekey ][ $columnkey ] ) ) {
2469 $typeinfo = explode( '(', $this->col_meta[ $tablekey ][ $columnkey ]->Type );
2471 $type = strtolower( $typeinfo[0] );
2472 if ( ! empty( $typeinfo[1] ) ) {
2473 $length = trim( $typeinfo[1], ')' );
2483 'length' => (int) $length,
2490 'length' => (int) $length,
2497 'length' => 255, // 2^8 - 1
2504 'length' => 65535, // 2^16 - 1
2511 'length' => 16777215, // 2^24 - 1
2518 'length' => 4294967295, // 2^32 - 1
2529 * Check if a string is ASCII.
2531 * The negative regex is faster for non-ASCII strings, as it allows
2532 * the search to finish as soon as it encounters a non-ASCII character.
2537 * @param string $string String to check.
2538 * @return bool True if ASCII, false if not.
2540 protected function check_ascii( $string ) {
2541 if ( function_exists( 'mb_check_encoding' ) ) {
2542 if ( mb_check_encoding( $string, 'ASCII' ) ) {
2545 } elseif ( ! preg_match( '/[^\x00-\x7F]/', $string ) ) {
2553 * Check if the query is accessing a collation considered safe on the current version of MySQL.
2558 * @param string $query The query to check.
2559 * @return bool True if the collation is safe, false if it isn't.
2561 protected function check_safe_collation( $query ) {
2562 if ( $this->checking_collation ) {
2566 // We don't need to check the collation for queries that don't read data.
2567 $query = ltrim( $query, "\r\n\t (" );
2568 if ( preg_match( '/^(?:SHOW|DESCRIBE|DESC|EXPLAIN|CREATE)\s/i', $query ) ) {
2572 // All-ASCII queries don't need extra checking.
2573 if ( $this->check_ascii( $query ) ) {
2577 $table = $this->get_table_from_query( $query );
2582 $this->checking_collation = true;
2583 $collation = $this->get_table_charset( $table );
2584 $this->checking_collation = false;
2586 // Tables with no collation, or latin1 only, don't need extra checking.
2587 if ( false === $collation || 'latin1' === $collation ) {
2591 $table = strtolower( $table );
2592 if ( empty( $this->col_meta[ $table ] ) ) {
2596 // If any of the columns don't have one of these collations, it needs more sanity checking.
2597 foreach( $this->col_meta[ $table ] as $col ) {
2598 if ( empty( $col->Collation ) ) {
2602 if ( ! in_array( $col->Collation, array( 'utf8_general_ci', 'utf8_bin', 'utf8mb4_general_ci', 'utf8mb4_bin' ), true ) ) {
2611 * Strips any invalid characters based on value/charset pairs.
2616 * @param array $data Array of value arrays. Each value array has the keys
2617 * 'value' and 'charset'. An optional 'ascii' key can be
2618 * set to false to avoid redundant ASCII checks.
2619 * @return array|WP_Error The $data parameter, with invalid characters removed from
2620 * each value. This works as a passthrough: any additional keys
2621 * such as 'field' are retained in each value array. If we cannot
2622 * remove invalid characters, a WP_Error object is returned.
2624 protected function strip_invalid_text( $data ) {
2625 $db_check_string = false;
2627 foreach ( $data as &$value ) {
2628 $charset = $value['charset'];
2630 if ( is_array( $value['length'] ) ) {
2631 $length = $value['length']['length'];
2632 $truncate_by_byte_length = 'byte' === $value['length']['type'];
2635 // Since we have no length, we'll never truncate.
2636 // Initialize the variable to false. true would take us
2637 // through an unnecessary (for this case) codepath below.
2638 $truncate_by_byte_length = false;
2641 // There's no charset to work with.
2642 if ( false === $charset ) {
2646 // Column isn't a string.
2647 if ( ! is_string( $value['value'] ) ) {
2651 $needs_validation = true;
2653 // latin1 can store any byte sequence
2654 'latin1' === $charset
2656 // ASCII is always OK.
2657 ( ! isset( $value['ascii'] ) && $this->check_ascii( $value['value'] ) )
2659 $truncate_by_byte_length = true;
2660 $needs_validation = false;
2663 if ( $truncate_by_byte_length ) {
2664 mbstring_binary_safe_encoding();
2665 if ( false !== $length && strlen( $value['value'] ) > $length ) {
2666 $value['value'] = substr( $value['value'], 0, $length );
2668 reset_mbstring_encoding();
2670 if ( ! $needs_validation ) {
2675 // utf8 can be handled by regex, which is a bunch faster than a DB lookup.
2676 if ( ( 'utf8' === $charset || 'utf8mb3' === $charset || 'utf8mb4' === $charset ) && function_exists( 'mb_strlen' ) ) {
2679 (?: [\x00-\x7F] # single-byte sequences 0xxxxxxx
2680 | [\xC2-\xDF][\x80-\xBF] # double-byte sequences 110xxxxx 10xxxxxx
2681 | \xE0[\xA0-\xBF][\x80-\xBF] # triple-byte sequences 1110xxxx 10xxxxxx * 2
2682 | [\xE1-\xEC][\x80-\xBF]{2}
2683 | \xED[\x80-\x9F][\x80-\xBF]
2684 | [\xEE-\xEF][\x80-\xBF]{2}';
2686 if ( 'utf8mb4' === $charset ) {
2688 | \xF0[\x90-\xBF][\x80-\xBF]{2} # four-byte sequences 11110xxx 10xxxxxx * 3
2689 | [\xF1-\xF3][\x80-\xBF]{3}
2690 | \xF4[\x80-\x8F][\x80-\xBF]{2}
2694 $regex .= '){1,40} # ...one or more times
2698 $value['value'] = preg_replace( $regex, '$1', $value['value'] );
2701 if ( false !== $length && mb_strlen( $value['value'], 'UTF-8' ) > $length ) {
2702 $value['value'] = mb_substr( $value['value'], 0, $length, 'UTF-8' );
2707 // We couldn't use any local conversions, send it to the DB.
2708 $value['db'] = $db_check_string = true;
2710 unset( $value ); // Remove by reference.
2712 if ( $db_check_string ) {
2714 foreach ( $data as $col => $value ) {
2715 if ( ! empty( $value['db'] ) ) {
2716 // We're going to need to truncate by characters or bytes, depending on the length value we have.
2717 if ( 'byte' === $value['length']['type'] ) {
2718 // Using binary causes LEFT() to truncate by bytes.
2719 $charset = 'binary';
2721 $charset = $value['charset'];
2724 if ( is_array( $value['length'] ) ) {
2725 $queries[ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING $charset ), %.0f ) USING {$this->charset} )", $value['value'], $value['length']['length'] );
2726 } else if ( 'binary' !== $charset ) {
2727 // If we don't have a length, there's no need to convert binary - it will always return the same result.
2728 $queries[ $col ] = $this->prepare( "CONVERT( CONVERT( %s USING $charset ) USING {$this->charset} )", $value['value'] );
2731 unset( $data[ $col ]['db'] );
2736 foreach ( $queries as $column => $query ) {
2741 $sql[] = $query . " AS x_$column";
2744 $this->check_current_query = false;
2745 $row = $this->get_row( "SELECT " . implode( ', ', $sql ), ARRAY_A );
2747 return new WP_Error( 'wpdb_strip_invalid_text_failure' );
2750 foreach ( array_keys( $data ) as $column ) {
2751 if ( isset( $row["x_$column"] ) ) {
2752 $data[ $column ]['value'] = $row["x_$column"];
2761 * Strips any invalid characters from the query.
2766 * @param string $query Query to convert.
2767 * @return string|WP_Error The converted query, or a WP_Error object if the conversion fails.
2769 protected function strip_invalid_text_from_query( $query ) {
2770 // We don't need to check the collation for queries that don't read data.
2771 $trimmed_query = ltrim( $query, "\r\n\t (" );
2772 if ( preg_match( '/^(?:SHOW|DESCRIBE|DESC|EXPLAIN|CREATE)\s/i', $trimmed_query ) ) {
2776 $table = $this->get_table_from_query( $query );
2778 $charset = $this->get_table_charset( $table );
2779 if ( is_wp_error( $charset ) ) {
2783 // We can't reliably strip text from tables containing binary/blob columns
2784 if ( 'binary' === $charset ) {
2788 $charset = $this->charset;
2793 'charset' => $charset,
2798 $data = $this->strip_invalid_text( array( $data ) );
2799 if ( is_wp_error( $data ) ) {
2803 return $data[0]['value'];
2807 * Strips any invalid characters from the string for a given table and column.
2812 * @param string $table Table name.
2813 * @param string $column Column name.
2814 * @param string $value The text to check.
2815 * @return string|WP_Error The converted string, or a WP_Error object if the conversion fails.
2817 public function strip_invalid_text_for_column( $table, $column, $value ) {
2818 if ( ! is_string( $value ) ) {
2822 $charset = $this->get_col_charset( $table, $column );
2824 // Not a string column.
2826 } elseif ( is_wp_error( $charset ) ) {
2827 // Bail on real errors.
2834 'charset' => $charset,
2835 'length' => $this->get_col_length( $table, $column ),
2839 $data = $this->strip_invalid_text( $data );
2840 if ( is_wp_error( $data ) ) {
2844 return $data[ $column ]['value'];
2848 * Find the first table name referenced in a query.
2853 * @param string $query The query to search.
2854 * @return string|false $table The table name found, or false if a table couldn't be found.
2856 protected function get_table_from_query( $query ) {
2857 // Remove characters that can legally trail the table name.
2858 $query = rtrim( $query, ';/-#' );
2860 // Allow (select...) union [...] style queries. Use the first query's table name.
2861 $query = ltrim( $query, "\r\n\t (" );
2863 // Strip everything between parentheses except nested selects.
2864 $query = preg_replace( '/\((?!\s*select)[^(]*?\)/is', '()', $query );
2866 // Quickly match most common queries.
2867 if ( preg_match( '/^\s*(?:'
2868 . 'SELECT.*?\s+FROM'
2869 . '|INSERT(?:\s+LOW_PRIORITY|\s+DELAYED|\s+HIGH_PRIORITY)?(?:\s+IGNORE)?(?:\s+INTO)?'
2870 . '|REPLACE(?:\s+LOW_PRIORITY|\s+DELAYED)?(?:\s+INTO)?'
2871 . '|UPDATE(?:\s+LOW_PRIORITY)?(?:\s+IGNORE)?'
2872 . '|DELETE(?:\s+LOW_PRIORITY|\s+QUICK|\s+IGNORE)*(?:\s+FROM)?'
2873 . ')\s+((?:[0-9a-zA-Z$_.`-]|[\xC2-\xDF][\x80-\xBF])+)/is', $query, $maybe ) ) {
2874 return str_replace( '`', '', $maybe[1] );
2877 // SHOW TABLE STATUS and SHOW TABLES
2878 if ( preg_match( '/^\s*(?:'
2879 . 'SHOW\s+TABLE\s+STATUS.+(?:LIKE\s+|WHERE\s+Name\s*=\s*)'
2880 . '|SHOW\s+(?:FULL\s+)?TABLES.+(?:LIKE\s+|WHERE\s+Name\s*=\s*)'
2881 . ')\W((?:[0-9a-zA-Z$_.`-]|[\xC2-\xDF][\x80-\xBF])+)\W/is', $query, $maybe ) ) {
2882 return str_replace( '`', '', $maybe[1] );
2885 // Big pattern for the rest of the table-related queries.
2886 if ( preg_match( '/^\s*(?:'
2887 . '(?:EXPLAIN\s+(?:EXTENDED\s+)?)?SELECT.*?\s+FROM'
2888 . '|DESCRIBE|DESC|EXPLAIN|HANDLER'
2889 . '|(?:LOCK|UNLOCK)\s+TABLE(?:S)?'
2890 . '|(?:RENAME|OPTIMIZE|BACKUP|RESTORE|CHECK|CHECKSUM|ANALYZE|REPAIR).*\s+TABLE'
2891 . '|TRUNCATE(?:\s+TABLE)?'
2892 . '|CREATE(?:\s+TEMPORARY)?\s+TABLE(?:\s+IF\s+NOT\s+EXISTS)?'
2893 . '|ALTER(?:\s+IGNORE)?\s+TABLE'
2894 . '|DROP\s+TABLE(?:\s+IF\s+EXISTS)?'
2895 . '|CREATE(?:\s+\w+)?\s+INDEX.*\s+ON'
2896 . '|DROP\s+INDEX.*\s+ON'
2897 . '|LOAD\s+DATA.*INFILE.*INTO\s+TABLE'
2898 . '|(?:GRANT|REVOKE).*ON\s+TABLE'
2899 . '|SHOW\s+(?:.*FROM|.*TABLE)'
2900 . ')\s+\(*\s*((?:[0-9a-zA-Z$_.`-]|[\xC2-\xDF][\x80-\xBF])+)\s*\)*/is', $query, $maybe ) ) {
2901 return str_replace( '`', '', $maybe[1] );
2908 * Load the column metadata from the last query.
2914 protected function load_col_info() {
2915 if ( $this->col_info )
2918 if ( $this->use_mysqli ) {
2919 $num_fields = @mysqli_num_fields( $this->result );
2920 for ( $i = 0; $i < $num_fields; $i++ ) {
2921 $this->col_info[ $i ] = @mysqli_fetch_field( $this->result );
2924 $num_fields = @mysql_num_fields( $this->result );
2925 for ( $i = 0; $i < $num_fields; $i++ ) {
2926 $this->col_info[ $i ] = @mysql_fetch_field( $this->result, $i );
2932 * Retrieve column metadata from the last query.
2936 * @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
2937 * @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
2938 * @return mixed Column Results
2940 public function get_col_info( $info_type = 'name', $col_offset = -1 ) {
2941 $this->load_col_info();
2943 if ( $this->col_info ) {
2944 if ( $col_offset == -1 ) {
2946 $new_array = array();
2947 foreach( (array) $this->col_info as $col ) {
2948 $new_array[$i] = $col->{$info_type};
2953 return $this->col_info[$col_offset]->{$info_type};
2959 * Starts the timer, for debugging purposes.
2965 public function timer_start() {
2966 $this->time_start = microtime( true );
2971 * Stops the debugging timer.
2975 * @return float Total time spent on the query, in seconds
2977 public function timer_stop() {
2978 return ( microtime( true ) - $this->time_start );
2982 * Wraps errors in a nice header and footer and dies.
2984 * Will not die if wpdb::$show_errors is false.
2988 * @param string $message The Error message
2989 * @param string $error_code Optional. A Computer readable string to identify the error.
2990 * @return false|void
2992 public function bail( $message, $error_code = '500' ) {
2993 if ( !$this->show_errors ) {
2994 if ( class_exists( 'WP_Error' ) )
2995 $this->error = new WP_Error($error_code, $message);
2997 $this->error = $message;
3004 * Whether MySQL database is at least the required minimum version.
3008 * @global string $wp_version
3009 * @global string $required_mysql_version
3011 * @return WP_Error|void
3013 public function check_database_version() {
3014 global $wp_version, $required_mysql_version;
3015 // Make sure the server has the required MySQL version
3016 if ( version_compare($this->db_version(), $required_mysql_version, '<') )
3017 return new WP_Error('database_version', sprintf( __( '<strong>ERROR</strong>: WordPress %1$s requires MySQL %2$s or higher' ), $wp_version, $required_mysql_version ));
3021 * Whether the database supports collation.
3023 * Called when WordPress is generating the table scheme.
3027 * @deprecated Use wpdb::has_cap( 'collation' )
3029 * @return bool True if collation is supported, false if version does not
3031 public function supports_collation() {
3032 _deprecated_function( __FUNCTION__, '3.5', 'wpdb::has_cap( \'collation\' )' );
3033 return $this->has_cap( 'collation' );
3037 * The database character collate.
3041 * @return string The database character collate.
3043 public function get_charset_collate() {
3044 $charset_collate = '';
3046 if ( ! empty( $this->charset ) )
3047 $charset_collate = "DEFAULT CHARACTER SET $this->charset";
3048 if ( ! empty( $this->collate ) )
3049 $charset_collate .= " COLLATE $this->collate";
3051 return $charset_collate;
3055 * Determine if a database supports a particular feature.
3058 * @since 4.1.0 Support was added for the 'utf8mb4' feature.
3060 * @see wpdb::db_version()
3062 * @param string $db_cap The feature to check for. Accepts 'collation',
3063 * 'group_concat', 'subqueries', 'set_charset',
3065 * @return int|false Whether the database feature is supported, false otherwise.
3067 public function has_cap( $db_cap ) {
3068 $version = $this->db_version();
3070 switch ( strtolower( $db_cap ) ) {
3071 case 'collation' : // @since 2.5.0
3072 case 'group_concat' : // @since 2.7.0
3073 case 'subqueries' : // @since 2.7.0
3074 return version_compare( $version, '4.1', '>=' );
3075 case 'set_charset' :
3076 return version_compare( $version, '5.0.7', '>=' );
3077 case 'utf8mb4' : // @since 4.1.0
3078 if ( version_compare( $version, '5.5.3', '<' ) ) {
3081 if ( $this->use_mysqli ) {
3082 $client_version = mysqli_get_client_info();
3084 $client_version = mysql_get_client_info();
3088 * libmysql has supported utf8mb4 since 5.5.3, same as the MySQL server.
3089 * mysqlnd has supported utf8mb4 since 5.0.9.
3091 if ( false !== strpos( $client_version, 'mysqlnd' ) ) {
3092 $client_version = preg_replace( '/^\D+([\d.]+).*/', '$1', $client_version );
3093 return version_compare( $client_version, '5.0.9', '>=' );
3095 return version_compare( $client_version, '5.5.3', '>=' );
3103 * Retrieve the name of the function that called wpdb.
3105 * Searches up the list of functions until it reaches
3106 * the one that would most logically had called this method.
3110 * @return string|array The name of the calling function
3112 public function get_caller() {
3113 return wp_debug_backtrace_summary( __CLASS__ );
3117 * The database version number.
3121 * @return null|string Null on failure, version number on success.
3123 public function db_version() {
3124 if ( $this->use_mysqli ) {
3125 $server_info = mysqli_get_server_info( $this->dbh );
3127 $server_info = mysql_get_server_info( $this->dbh );
3129 return preg_replace( '/[^0-9.].*/', '', $server_info );