wpdb::replace() WordPress Method
The wpdb::replace() method is used to replace a row in a database table if it exists, or insert a new row if it does not. This method takes three parameters: the table name, an associative array of data to be inserted or updated, and an array of data types for the columns in the table.
wpdb::replace( string $table, array $data, array|string $format = null ) #
Replaces a row in the table.
Description
Examples:
wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )See also
- wpdb::prepare()
- wpdb::$field_types
- wp_set_wpdb_vars()
Parameters
- $table
(string)(Required)Table name.
- $data
(array)(Required)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.
- $format
(array|string)(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.
Default value: null
Return
(int|false) The number of rows affected, or false on error.
Source
File: wp-includes/wp-db.php
public function replace( $table, $data, $format = null ) {
return $this->_insert_replace_helper( $table, $data, $format, 'REPLACE' );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |