* Amount of queries made
*
* @since 1.2.0
- * @access private
+ * @access public
* @var int
*/
- var $num_queries = 0;
+ public $num_queries = 0;
/**
* Count of rows returned by previous query
*
* @since 0.71
- * @access private
+ * @access public
* @var int
*/
- var $num_rows = 0;
+ public $num_rows = 0;
/**
* Count of affected rows by previous query
* @access public
* @var int
*/
- var $insert_id = 0;
+ public $insert_id = 0;
/**
* Last query made
* @since 4.2.0
* @access private
* @see wpdb::check_safe_collation()
- * @var boolean
+ * @var bool
*/
private $checking_collation = false;
* security precautions.
*
* @since 2.5.0
- * @access private
+ * @access public
* @var string
*/
- var $prefix = '';
+ public $prefix = '';
/**
* WordPress base table prefix.
* @var array
*/
var $tables = array( 'posts', 'comments', 'links', 'options', 'postmeta',
- 'terms', 'term_taxonomy', 'term_relationships', 'commentmeta' );
+ 'terms', 'term_taxonomy', 'term_relationships', 'termmeta', 'commentmeta' );
/**
* List of deprecated WordPress tables
*/
public $term_taxonomy;
- /*
- * Global and Multisite tables
+ /**
+ * WordPress Term Meta table.
+ *
+ * @since 4.4.0
+ * @access public
+ * @var string
*/
+ public $termmeta;
+
+ //
+ // Global and Multisite tables
+ //
/**
* WordPress User Metadata table
* @link https://core.trac.wordpress.org/ticket/3354
* @since 2.0.8
*
- * @param string $dbuser MySQL database user
+ * @global string $wp_version
+ *
+ * @param string $dbuser MySQL database user
* @param string $dbpassword MySQL database password
- * @param string $dbname MySQL database name
- * @param string $dbhost MySQL database host
+ * @param string $dbname MySQL database name
+ * @param string $dbhost MySQL database host
*/
public function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) {
register_shutdown_function( array( $this, '__destruct' ) );
*
* @see wpdb::__construct()
* @since 2.0.8
- * @return bool true
+ * @return true
*/
public function __destruct() {
return true;
*/
$incompatible_modes = (array) apply_filters( 'incompatible_sql_modes', $this->incompatible_modes );
- foreach( $modes as $i => $mode ) {
+ foreach ( $modes as $i => $mode ) {
if ( in_array( $mode, $incompatible_modes ) ) {
unset( $modes[ $i ] );
}
*
* @since 2.5.0
*
- * @param string $prefix Alphanumeric name for the new prefix.
- * @param bool $set_table_names Optional. Whether the table names, e.g. wpdb::$posts, should be updated or not.
+ * @param string $prefix Alphanumeric name for the new prefix.
+ * @param bool $set_table_names Optional. Whether the table names, e.g. wpdb::$posts, should be updated or not.
* @return string|WP_Error Old prefix or WP_Error on error
*/
public function set_prefix( $prefix, $set_table_names = true ) {
*
* @since 3.0.0
* @access public
+ *
* @param int $blog_id
* @param int $site_id Optional.
* @return int previous blog id
* @uses wpdb::$global_tables
* @uses wpdb::$ms_global_tables
*
- * @param string $scope Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all.
- * @param bool $prefix Optional. Whether to include table prefixes. Default true. If blog
- * prefix is requested, then the custom users and usermeta tables will be mapped.
- * @param int $blog_id Optional. The blog_id to prefix. Defaults to wpdb::$blogid. Used only when prefix is requested.
+ * @param string $scope Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all.
+ * @param bool $prefix Optional. Whether to include table prefixes. Default true. If blog
+ * prefix is requested, then the custom users and usermeta tables will be mapped.
+ * @param int $blog_id Optional. The blog_id to prefix. Defaults to wpdb::$blogid. Used only when prefix is requested.
* @return array Table names. When a prefix is requested, the key is the unprefixed table name.
*/
public function tables( $scope = 'all', $prefix = true, $blog_id = 0 ) {
*
* @since 0.71
*
- * @param string $db MySQL database name
- * @param resource $dbh Optional link identifier.
- * @return null Always null.
+ * @param string $db MySQL database name
+ * @param resource|null $dbh Optional link identifier.
*/
public function select( $db, $dbh = null ) {
if ( is_null($dbh) )
$dbh = $this->dbh;
if ( $this->use_mysqli ) {
- $success = @mysqli_select_db( $dbh, $db );
+ $success = mysqli_select_db( $dbh, $db );
} else {
- $success = @mysql_select_db( $db, $dbh );
+ $success = mysql_select_db( $db, $dbh );
}
if ( ! $success ) {
$this->ready = false;
if ( ! did_action( 'template_redirect' ) ) {
wp_load_translations_early();
- $this->bail( sprintf( __( '<h1>Can’t select database</h1>
-<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>
-<ul>
-<li>Are you sure it exists?</li>
-<li>Does the user <code>%2$s</code> have permission to use the <code>%1$s</code> database?</li>
-<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>
-</ul>
-<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' );
+
+ $message = '<h1>' . __( 'Can’t select database' ) . "</h1>\n";
+
+ $message .= '<p>' . sprintf(
+ /* translators: %s: database name */
+ __( 'We were able to connect to the database server (which means your username and password is okay) but not able to select the %s database.' ),
+ '<code>' . htmlspecialchars( $db, ENT_QUOTES ) . '</code>'
+ ) . "</p>\n";
+
+ $message .= "<ul>\n";
+ $message .= '<li>' . __( 'Are you sure it exists?' ) . "</li>\n";
+
+ $message .= '<li>' . sprintf(
+ /* translators: 1: database user, 2: database name */
+ __( 'Does the user %1$s have permission to use the %2$s database?' ),
+ '<code>' . htmlspecialchars( $this->dbuser, ENT_QUOTES ) . '</code>',
+ '<code>' . htmlspecialchars( $db, ENT_QUOTES ) . '</code>'
+ ) . "</li>\n";
+
+ $message .= '<li>' . sprintf(
+ /* translators: %s: database name */
+ __( '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?' ),
+ htmlspecialchars( $db, ENT_QUOTES )
+ ). "</li>\n";
+
+ $message .= "</ul>\n";
+
+ $message .= '<p>' . sprintf(
+ /* translators: %s: support forums URL */
+ __( '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="%s">WordPress Support Forums</a>.' ),
+ __( 'https://wordpress.org/support/' )
+ ) . "</p>\n";
+
+ $this->bail( $message, 'db_select_fail' );
}
- return;
}
}
* Use esc_sql() or wpdb::prepare() instead.
*
* @since 2.8.0
- * @deprecated 3.6.0
+ * @deprecated 3.6.0 Use wpdb::prepare()
* @see wpdb::prepare
* @see esc_sql()
* @access private
$class = get_class( $this );
if ( function_exists( '__' ) ) {
+ /* translators: %s: database access abstraction class, usually wpdb or a class extending wpdb */
_doing_it_wrong( $class, sprintf( __( '%s must set a database connection for use with escaping.' ), $class ), E_USER_NOTICE );
} else {
_doing_it_wrong( $class, sprintf( '%s must set a database connection for use with escaping.', $class ), E_USER_NOTICE );
* Use esc_sql() or wpdb::prepare() instead.
*
* @since 0.71
- * @deprecated 3.6.0
+ * @deprecated 3.6.0 Use wpdb::prepare()
* @see wpdb::prepare()
* @see esc_sql()
*
* Escapes content by reference for insertion into the database, for security
*
* @uses wpdb::_real_escape()
+ *
* @since 2.3.0
+ *
* @param string $string to escape
- * @return void
*/
public function escape_by_ref( &$string ) {
if ( ! is_float( $string ) )
* @link http://php.net/sprintf Description of syntax.
* @since 2.3.0
*
- * @param string $query Query statement with sprintf()-like placeholders
- * @param array|mixed $args The array of variables to substitute into the query's placeholders if being called like
- * {@link http://php.net/vsprintf vsprintf()}, or the first variable to substitute into the query's placeholders if
- * being called like {@link http://php.net/sprintf sprintf()}.
- * @param mixed $args,... further variables to substitute into the query's placeholders if being called like
- * {@link http://php.net/sprintf sprintf()}.
- * @return null|false|string Sanitized query string, null if there is no query, false if there is an error and string
- * if there was something to prepare
+ * @param string $query Query statement with sprintf()-like placeholders
+ * @param array|mixed $args The array of variables to substitute into the query's placeholders if being called like
+ * {@link http://php.net/vsprintf vsprintf()}, or the first variable to substitute into the query's placeholders if
+ * being called like {@link http://php.net/sprintf sprintf()}.
+ * @param mixed $args,... further variables to substitute into the query's placeholders if being called like
+ * {@link http://php.net/sprintf sprintf()}.
+ * @return string|void Sanitized query string, if there is a query to prepare.
*/
public function prepare( $query, $args ) {
if ( is_null( $query ) )
* Use this only before wpdb::prepare() or esc_sql(). Reversing the order is very bad for security.
*
* Example Prepared Statement:
- * $wild = '%';
- * $find = 'only 43% of planets';
- * $like = $wild . $wpdb->esc_like( $find ) . $wild;
- * $sql = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE %s", $like );
+ *
+ * $wild = '%';
+ * $find = 'only 43% of planets';
+ * $like = $wild . $wpdb->esc_like( $find ) . $wild;
+ * $sql = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE '%s'", $like );
*
* Example Escape Chain:
- * $sql = esc_sql( $wpdb->esc_like( $input ) );
+ *
+ * $sql = esc_sql( $wpdb->esc_like( $input ) );
*
* @since 4.0.0
* @access public
* @global array $EZSQL_ERROR Stores error information of query and error string
*
* @param string $str The error to display
- * @return false|null False if the showing of errors is disabled.
+ * @return false|void False if the showing of errors is disabled.
*/
public function print_error( $str = '' ) {
global $EZSQL_ERROR;
// If there is an error then take note of it
if ( is_multisite() ) {
- $msg = "WordPress database error: [$str]\n{$this->last_query}\n";
- if ( defined( 'ERRORLOGFILE' ) )
+ $msg = sprintf(
+ "%s [%s]\n%s\n",
+ __( 'WordPress database error:' ),
+ $str,
+ $this->last_query
+ );
+
+ if ( defined( 'ERRORLOGFILE' ) ) {
error_log( $msg, 3, ERRORLOGFILE );
- if ( defined( 'DIEONDBERROR' ) )
+ }
+ if ( defined( 'DIEONDBERROR' ) ) {
wp_die( $msg );
+ }
} else {
$str = htmlspecialchars( $str, ENT_QUOTES );
$query = htmlspecialchars( $this->last_query, ENT_QUOTES );
- print "<div id='error'>
- <p class='wpdberror'><strong>WordPress database error:</strong> [$str]<br />
- <code>$query</code></p>
- </div>";
+ printf(
+ '<div id="error"><p class="wpdberror"><strong>%s</strong> [%s]<br /><code>%s</code></p></div>',
+ __( 'WordPress database error:' ),
+ $str,
+ $query
+ );
}
}
* Kill cached query results.
*
* @since 0.71
- * @return void
*/
public function flush() {
$this->last_result = array();
* @since 3.9.0 $allow_bail parameter added.
*
* @param bool $allow_bail Optional. Allows the function to bail. Default true.
- * @return null|bool True with a successful connection, false on failure.
+ * @return bool True with a successful connection, false on failure.
*/
public function db_connect( $allow_bail = true ) {
-
$this->is_mysql = true;
/*
}
}
- if ( WP_DEBUG ) {
- mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
- } else {
- @mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
- }
+ mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
if ( $this->dbh->connect_errno ) {
$this->dbh = null;
if ( $attempt_fallback ) {
$this->use_mysqli = false;
- $this->db_connect();
+ return $this->db_connect( $allow_bail );
}
}
} else {
- if ( WP_DEBUG ) {
- $this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
- } else {
- $this->dbh = @mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
- }
+ $this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
}
if ( ! $this->dbh && $allow_bail ) {
die();
}
- $this->bail( sprintf( __( "
-<h1>Error establishing a database connection</h1>
-<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>
-<ul>
- <li>Are you sure you have the correct username and password?</li>
- <li>Are you sure that you have typed the correct hostname?</li>
- <li>Are you sure that the database server is running?</li>
-</ul>
-<p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='https://wordpress.org/support/'>WordPress Support Forums</a>.</p>
-" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' );
+ $message = '<h1>' . __( 'Error establishing a database connection' ) . "</h1>\n";
+
+ $message .= '<p>' . sprintf(
+ /* translators: 1: wp-config.php. 2: database host */
+ __( 'This either means that the username and password information in your %1$s file is incorrect or we can’t contact the database server at %2$s. This could mean your host’s database server is down.' ),
+ '<code>wp-config.php</code>',
+ '<code>' . htmlspecialchars( $this->dbhost, ENT_QUOTES ) . '</code>'
+ ) . "</p>\n";
+
+ $message .= "<ul>\n";
+ $message .= '<li>' . __( 'Are you sure you have the correct username and password?' ) . "</li>\n";
+ $message .= '<li>' . __( 'Are you sure that you have typed the correct hostname?' ) . "</li>\n";
+ $message .= '<li>' . __( 'Are you sure that the database server is running?' ) . "</li>\n";
+ $message .= "</ul>\n";
+
+ $message .= '<p>' . sprintf(
+ /* translators: %s: support forums URL */
+ __( '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="%s">WordPress Support Forums</a>.' ),
+ __( 'https://wordpress.org/support/' )
+ ) . "</p>\n";
+
+ $this->bail( $message, 'db_connect_fail' );
return false;
} elseif ( $this->dbh ) {
* @since 3.9.0
*
* @param bool $allow_bail Optional. Allows the function to bail. Default true.
- * @return bool|null True if the connection is up.
+ * @return bool|void True if the connection is up.
*/
public function check_connection( $allow_bail = true ) {
if ( $this->use_mysqli ) {
- if ( @mysqli_ping( $this->dbh ) ) {
+ if ( ! empty( $this->dbh ) && mysqli_ping( $this->dbh ) ) {
return true;
}
} else {
- if ( @mysql_ping( $this->dbh ) ) {
+ if ( ! empty( $this->dbh ) && mysql_ping( $this->dbh ) ) {
return true;
}
}
return false;
}
+ wp_load_translations_early();
+
+ $message = '<h1>' . __( 'Error reconnecting to the database' ) . "</h1>\n";
+
+ $message .= '<p>' . sprintf(
+ /* translators: %s: database host */
+ __( 'This means that we lost contact with the database server at %s. This could mean your host’s database server is down.' ),
+ '<code>' . htmlspecialchars( $this->dbhost, ENT_QUOTES ) . '</code>'
+ ) . "</p>\n";
+
+ $message .= "<ul>\n";
+ $message .= '<li>' . __( 'Are you sure that the database server is running?' ) . "</li>\n";
+ $message .= '<li>' . __( 'Are you sure that the database server is not under particularly heavy load?' ) . "</li>\n";
+ $message .= "</ul>\n";
+
+ $message .= '<p>' . sprintf(
+ /* translators: %s: support forums URL */
+ __( '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="%s">WordPress Support Forums</a>.' ),
+ __( 'https://wordpress.org/support/' )
+ ) . "</p>\n";
+
// We weren't able to reconnect, so we better bail.
- $this->bail( sprintf( ( "
-<h1>Error reconnecting to the database</h1>
-<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>
-<ul>
- <li>Are you sure that the database server is running?</li>
- <li>Are you sure that the database server is not under particularly heavy load?</li>
-</ul>
-<p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='https://wordpress.org/support/'>WordPress Support Forums</a>.</p>
-" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' );
+ $this->bail( $message, 'db_connect_fail' );
// Call dead_db() if bail didn't die, because this database is no more. It has ceased to be (at least temporarily).
dead_db();
} else {
$num_rows = 0;
if ( $this->use_mysqli && $this->result instanceof mysqli_result ) {
- while ( $row = @mysqli_fetch_object( $this->result ) ) {
+ while ( $row = mysqli_fetch_object( $this->result ) ) {
$this->last_result[$num_rows] = $row;
$num_rows++;
}
} elseif ( is_resource( $this->result ) ) {
- while ( $row = @mysql_fetch_object( $this->result ) ) {
+ while ( $row = mysql_fetch_object( $this->result ) ) {
$this->last_result[$num_rows] = $row;
$num_rows++;
}
$this->timer_start();
}
- if ( $this->use_mysqli ) {
- $this->result = @mysqli_query( $this->dbh, $query );
- } else {
- $this->result = @mysql_query( $query, $this->dbh );
+ if ( ! empty( $this->dbh ) && $this->use_mysqli ) {
+ $this->result = mysqli_query( $this->dbh, $query );
+ } elseif ( ! empty( $this->dbh ) ) {
+ $this->result = mysql_query( $query, $this->dbh );
}
$this->num_queries++;
* @see wpdb::$field_types
* @see wp_set_wpdb_vars()
*
- * @param string $table table name
- * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
- * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
- * A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+ * @param string $table Table name
+ * @param array $data Data to insert (in column => value pairs).
+ * Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+ * Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
+ * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
+ * If string, that format will be used for all of the values in $data.
+ * A format is one of '%d', '%f', '%s' (integer, float, string).
+ * If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
* @return int|false The number of rows inserted, or false on error.
*/
public function insert( $table, $data, $format = null ) {
* @see wpdb::$field_types
* @see wp_set_wpdb_vars()
*
- * @param string $table table name
- * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
- * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
- * A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+ * @param string $table Table name
+ * @param array $data Data to insert (in column => value pairs).
+ * Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+ * Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
+ * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
+ * If string, that format will be used for all of the values in $data.
+ * A format is one of '%d', '%f', '%s' (integer, float, string).
+ * If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
* @return int|false The number of rows affected, or false on error.
*/
public function replace( $table, $data, $format = null ) {
* @see wpdb::$field_types
* @see wp_set_wpdb_vars()
*
- * @param string $table table name
- * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
- * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
- * A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
- * @param string $type Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT.
+ * @param string $table Table name
+ * @param array $data Data to insert (in column => value pairs).
+ * Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+ * Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
+ * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
+ * If string, that format will be used for all of the values in $data.
+ * A format is one of '%d', '%f', '%s' (integer, float, string).
+ * If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+ * @param string $type Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT.
* @return int|false The number of rows affected, or false on error.
*/
function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {
$formats = $values = array();
foreach ( $data as $value ) {
+ if ( is_null( $value['value'] ) ) {
+ $formats[] = 'NULL';
+ continue;
+ }
+
$formats[] = $value['format'];
$values[] = $value['value'];
}
* @see wpdb::$field_types
* @see wp_set_wpdb_vars()
*
- * @param string $table table name
- * @param array $data Data to update (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
- * @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw".
- * @param array|string $format Optional. An array of formats to be mapped to each of the values in $data. If string, that format will be used for all of the values in $data.
- * A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
- * @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.
+ * @param string $table Table name
+ * @param array $data Data to update (in column => value pairs).
+ * Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+ * Sending a null value will cause the column to be set to NULL - the corresponding
+ * format is ignored in this case.
+ * @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".
+ * Sending a null value will create an IS NULL comparison - the corresponding format will be ignored in this case.
+ * @param array|string $format Optional. An array of formats to be mapped to each of the values in $data.
+ * If string, that format will be used for all of the values in $data.
+ * A format is one of '%d', '%f', '%s' (integer, float, string).
+ * If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+ * @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.
* @return int|false The number of rows updated, or false on error.
*/
public function update( $table, $data, $where, $format = null, $where_format = null ) {
$fields = $conditions = $values = array();
foreach ( $data as $field => $value ) {
+ if ( is_null( $value['value'] ) ) {
+ $fields[] = "`$field` = NULL";
+ continue;
+ }
+
$fields[] = "`$field` = " . $value['format'];
$values[] = $value['value'];
}
foreach ( $where as $field => $value ) {
+ if ( is_null( $value['value'] ) ) {
+ $conditions[] = "`$field` IS NULL";
+ continue;
+ }
+
$conditions[] = "`$field` = " . $value['format'];
$values[] = $value['value'];
}
* @see wpdb::$field_types
* @see wp_set_wpdb_vars()
*
- * @param string $table table name
- * @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw".
- * @param array|string $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.
+ * @param string $table Table name
+ * @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".
+ * Sending a null value will create an IS NULL comparison - the corresponding format will be ignored in this case.
+ * @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.
* @return int|false The number of rows updated, or false on error.
*/
public function delete( $table, $where, $where_format = null ) {
$conditions = $values = array();
foreach ( $where as $field => $value ) {
+ if ( is_null( $value['value'] ) ) {
+ $conditions[] = "`$field` IS NULL";
+ continue;
+ }
+
$conditions[] = "`$field` = " . $value['format'];
$values[] = $value['value'];
}
* @param string $table Table name.
* @param array $data Field/value pair.
* @param mixed $format Format for each field.
- * @return array|bool Returns an array of fields that contain paired values
+ * @return array|false Returns an array of fields that contain paired values
* and formats. Returns false for invalid values.
*/
protected function process_fields( $table, $data, $format ) {
*
* @param array $data As it comes from the wpdb::process_field_formats() method.
* @param string $table Table name.
- * @return The same array as $data with additional 'charset' keys.
+ * @return array|false The same array as $data with additional 'charset' keys.
*/
protected function process_field_charsets( $data, $table ) {
foreach ( $data as $field => $value ) {
if ( '%d' === $value['format'] || '%f' === $value['format'] ) {
- // We can skip this field if we know it isn't a string.
- // This checks %d/%f versus ! %s because it's sprintf() could take more.
+ /*
+ * We can skip this field if we know it isn't a string.
+ * This checks %d/%f versus ! %s because its sprintf() could take more.
+ */
$value['charset'] = false;
} else {
$value['charset'] = $this->get_col_charset( $table, $field );
*
* @param array $data As it comes from the wpdb::process_field_charsets() method.
* @param string $table Table name.
- * @return array|False The same array as $data with additional 'length' keys, or false if
+ * @return array|false The same array as $data with additional 'length' keys, or false if
* any of the values were too long for their corresponding field.
*/
protected function process_field_lengths( $data, $table ) {
foreach ( $data as $field => $value ) {
if ( '%d' === $value['format'] || '%f' === $value['format'] ) {
- // We can skip this field if we know it isn't a string.
- // This checks %d/%f versus ! %s because it's sprintf() could take more.
+ /*
+ * We can skip this field if we know it isn't a string.
+ * This checks %d/%f versus ! %s because its sprintf() could take more.
+ */
$value['length'] = false;
} else {
$value['length'] = $this->get_col_length( $table, $field );
* @since 0.71
*
* @param string|null $query Optional. SQL query. Defaults to null, use the result from the previous query.
- * @param int $x Optional. Column of value to return. Indexed from 0.
- * @param int $y Optional. Row of value to return. Indexed from 0.
+ * @param int $x Optional. Column of value to return. Indexed from 0.
+ * @param int $y Optional. Row of value to return. Indexed from 0.
* @return string|null Database query result (as string), or null on failure
*/
public function get_var( $query = null, $x = 0, $y = 0 ) {
*
* @since 0.71
*
- * @param string|null $query SQL query.
- * @param string $output Optional. one of ARRAY_A | ARRAY_N | OBJECT constants. Return an associative array (column => value, ...),
- * a numerically indexed array (0 => value, ...) or an object ( ->column = value ), respectively.
- * @param int $y Optional. Row to return. Indexed from 0.
- * @return mixed Database query result in format specified by $output or null on failure
+ * @param string|null $query SQL query.
+ * @param string $output Optional. one of ARRAY_A | ARRAY_N | OBJECT constants.
+ * Return an associative array (column => value, ...),
+ * a numerically indexed array (0 => value, ...) or
+ * an object ( ->column = value ), respectively.
+ * @param int $y Optional. Row to return. Indexed from 0.
+ * @return array|object|null|void Database query result in format specified by $output or null on failure
*/
public function get_row( $query = null, $output = OBJECT, $y = 0 ) {
$this->func_call = "\$db->get_row(\"$query\",$output,$y)";
* @since 0.71
*
* @param string|null $query Optional. SQL query. Defaults to previous query.
- * @param int $x Optional. Column to return. Indexed from 0.
+ * @param int $x Optional. Column to return. Indexed from 0.
* @return array Database query result. Array indexed from 0 by SQL result row number.
*/
public function get_col( $query = null , $x = 0 ) {
*
* @since 0.71
*
- * @param string $query SQL query.
- * @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.
- * Each row is an associative array (column => value, ...), a numerically indexed array (0 => value, ...), or an object. ( ->column = value ), respectively.
- * With OBJECT_K, return an associative array of row objects keyed by the value of each row's first column's value. Duplicate keys are discarded.
- * @return mixed Database query results
+ * @param string $query SQL query.
+ * @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.
+ * Each row is an associative array (column => value, ...), a numerically indexed array (0 => value, ...), or an object. ( ->column = value ), respectively.
+ * With OBJECT_K, return an associative array of row objects keyed by the value of each row's first column's value.
+ * Duplicate keys are discarded.
+ * @return array|object|null Database query results
*/
public function get_results( $query = null, $output = OBJECT ) {
$this->func_call = "\$db->get_results(\"$query\", $output)";
} elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
// Return an integer-keyed array of...
if ( $this->last_result ) {
- foreach( (array) $this->last_result as $row ) {
+ foreach ( (array) $this->last_result as $row ) {
if ( $output == ARRAY_N ) {
// ...integer-keyed row arrays
$new_array[] = array_values( get_object_vars( $row ) );
*
* @param string $table Table name.
* @param string $column Column name.
- * @return mixed Column character set as a string. False if the column has no
- * character set. WP_Error object if there was an error.
+ * @return string|false|WP_Error Column character set as a string. False if the column has no
+ * character set. WP_Error object if there was an error.
*/
public function get_col_charset( $table, $column ) {
$tablekey = strtolower( $table );
}
// Skip this entirely if this isn't a MySQL database.
- if ( false === $this->is_mysql ) {
+ if ( empty( $this->is_mysql ) ) {
return false;
}
*
* @param string $table Table name.
* @param string $column Column name.
- * @return mixed array( 'length' => (int), 'type' => 'byte' | 'char' )
- * false if the column has no length (for example, numeric column)
- * WP_Error object if there was an error.
+ * @return array|false|WP_Error array( 'length' => (int), 'type' => 'byte' | 'char' )
+ * false if the column has no length (for example, numeric column)
+ * WP_Error object if there was an error.
*/
public function get_col_length( $table, $column ) {
$tablekey = strtolower( $table );
$columnkey = strtolower( $column );
// Skip this entirely if this isn't a MySQL database.
- if ( false === $this->is_mysql ) {
+ if ( empty( $this->is_mysql ) ) {
return false;
}
'type' => 'char',
'length' => (int) $length,
);
- break;
+
case 'binary':
case 'varbinary':
return array(
'type' => 'byte',
'length' => (int) $length,
);
- break;
+
case 'tinyblob':
case 'tinytext':
return array(
'type' => 'byte',
'length' => 255, // 2^8 - 1
);
- break;
+
case 'blob':
case 'text':
return array(
'type' => 'byte',
'length' => 65535, // 2^16 - 1
);
- break;
+
case 'mediumblob':
case 'mediumtext':
return array(
'type' => 'byte',
'length' => 16777215, // 2^24 - 1
);
- break;
+
case 'longblob':
case 'longtext':
return array(
'type' => 'byte',
'length' => 4294967295, // 2^32 - 1
);
- break;
+
default:
return false;
}
-
- return false;
}
/**
}
// If any of the columns don't have one of these collations, it needs more sanity checking.
- foreach( $this->col_meta[ $table ] as $col ) {
+ foreach ( $this->col_meta[ $table ] as $col ) {
if ( empty( $col->Collation ) ) {
continue;
}
$charset = $value['charset'];
}
+ if ( $this->charset ) {
+ $connection_charset = $this->charset;
+ } else {
+ if ( $this->use_mysqli ) {
+ $connection_charset = mysqli_character_set_name( $this->dbh );
+ } else {
+ $connection_charset = mysql_client_encoding();
+ }
+ }
+
if ( is_array( $value['length'] ) ) {
- $queries[ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING $charset ), %.0f ) USING {$this->charset} )", $value['value'], $value['length']['length'] );
+ $queries[ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING $charset ), %.0f ) USING $connection_charset )", $value['value'], $value['length']['length'] );
} else if ( 'binary' !== $charset ) {
// If we don't have a length, there's no need to convert binary - it will always return the same result.
- $queries[ $col ] = $this->prepare( "CONVERT( CONVERT( %s USING $charset ) USING {$this->charset} )", $value['value'] );
+ $queries[ $col ] = $this->prepare( "CONVERT( CONVERT( %s USING $charset ) USING $connection_charset )", $value['value'] );
}
unset( $data[ $col ]['db'] );
return;
if ( $this->use_mysqli ) {
- for ( $i = 0; $i < @mysqli_num_fields( $this->result ); $i++ ) {
- $this->col_info[ $i ] = @mysqli_fetch_field( $this->result );
+ $num_fields = mysqli_num_fields( $this->result );
+ for ( $i = 0; $i < $num_fields; $i++ ) {
+ $this->col_info[ $i ] = mysqli_fetch_field( $this->result );
}
} else {
- for ( $i = 0; $i < @mysql_num_fields( $this->result ); $i++ ) {
- $this->col_info[ $i ] = @mysql_fetch_field( $this->result, $i );
+ $num_fields = mysql_num_fields( $this->result );
+ for ( $i = 0; $i < $num_fields; $i++ ) {
+ $this->col_info[ $i ] = mysql_fetch_field( $this->result, $i );
}
}
}
*
* @since 0.71
*
- * @param string $info_type Optional. Type one of name, table, def, max_length, not_null, primary_key, multiple_key, unique_key, numeric, blob, type, unsigned, zerofill
- * @param int $col_offset Optional. 0: col name. 1: which table the col's in. 2: col's max length. 3: if the col is numeric. 4: col's type
+ * @param string $info_type Optional. Type one of name, table, def, max_length, not_null, primary_key, multiple_key, unique_key, numeric, blob, type, unsigned, zerofill
+ * @param int $col_offset Optional. 0: col name. 1: which table the col's in. 2: col's max length. 3: if the col is numeric. 4: col's type
* @return mixed Column Results
*/
public function get_col_info( $info_type = 'name', $col_offset = -1 ) {
if ( $col_offset == -1 ) {
$i = 0;
$new_array = array();
- foreach( (array) $this->col_info as $col ) {
+ foreach ( (array) $this->col_info as $col ) {
$new_array[$i] = $col->{$info_type};
$i++;
}
*
* @since 1.5.0
*
- * @return bool
+ * @return true
*/
public function timer_start() {
$this->time_start = microtime( true );
*
* @since 1.5.0
*
- * @param string $message The Error message
+ * @param string $message The Error message
* @param string $error_code Optional. A Computer readable string to identify the error.
* @return false|void
*/
public function bail( $message, $error_code = '500' ) {
if ( !$this->show_errors ) {
- if ( class_exists( 'WP_Error' ) )
+ if ( class_exists( 'WP_Error', false ) ) {
$this->error = new WP_Error($error_code, $message);
- else
+ } else {
$this->error = $message;
+ }
return false;
}
wp_die($message);
}
+
+ /**
+ * Closes the current database connection.
+ *
+ * @since 4.5.0
+ * @access public
+ *
+ * @return bool True if the connection was successfully closed, false if it wasn't,
+ * or the connection doesn't exist.
+ */
+ public function close() {
+ if ( ! $this->dbh ) {
+ return false;
+ }
+
+ if ( $this->use_mysqli ) {
+ $closed = mysqli_close( $this->dbh );
+ } else {
+ $closed = mysql_close( $this->dbh );
+ }
+
+ if ( $closed ) {
+ $this->dbh = null;
+ $this->ready = false;
+ $this->has_connected = false;
+ }
+
+ return $closed;
+ }
+
/**
* Whether MySQL database is at least the required minimum version.
*
* @since 2.5.0
- * @uses $wp_version
- * @uses $required_mysql_version
*
- * @return WP_Error
+ * @global string $wp_version
+ * @global string $required_mysql_version
+ *
+ * @return WP_Error|void
*/
public function check_database_version() {
global $wp_version, $required_mysql_version;
*
* Called when WordPress is generating the table scheme.
*
+ * Use `wpdb::has_cap( 'collation' )`.
+ *
* @since 2.5.0
- * @deprecated 3.5.0
- * @deprecated Use wpdb::has_cap( 'collation' )
+ * @deprecated 3.5.0 Use wpdb::has_cap()
*
* @return bool True if collation is supported, false if version does not
*/
* @param string $db_cap The feature to check for. Accepts 'collation',
* 'group_concat', 'subqueries', 'set_charset',
* or 'utf8mb4'.
- * @return bool Whether the database feature is supported, false otherwise.
+ * @return int|false Whether the database feature is supported, false otherwise.
*/
public function has_cap( $db_cap ) {
$version = $this->db_version();
*
* @since 2.5.0
*
- * @return string The name of the calling function
+ * @return string|array The name of the calling function
*/
public function get_caller() {
return wp_debug_backtrace_summary( __CLASS__ );
}
/**
- * The database version number.
+ * Retrieves the MySQL server version.
*
* @since 2.7.0
*
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff