wpdb::_insert_replace_helper( string $table, array $data, array|string $format = null, string $type = 'INSERT' ): int|false

Helper function for insert and replace.


Runs an insert or replace query based on $type argument.

Top ↑

See also

Top ↑


$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: null

$type string Optional
Type of operation. Either 'INSERT' or 'REPLACE'.
Default 'INSERT'.

Default: 'INSERT'

Top ↑


int|false The number of rows affected, or false on error.

Top ↑


File: wp-includes/class-wpdb.php. View all references

public function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {
	$this->insert_id = 0;

	if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ), true ) ) {
		return false;

	$data = $this->process_fields( $table, $data, $format );
	if ( false === $data ) {
		return false;

	$formats = array();
	$values  = array();
	foreach ( $data as $value ) {
		if ( is_null( $value['value'] ) ) {
			$formats[] = 'NULL';

		$formats[] = $value['format'];
		$values[]  = $value['value'];

	$fields  = '`' . implode( '`, `', array_keys( $data ) ) . '`';
	$formats = implode( ', ', $formats );

	$sql = "$type INTO `$table` ($fields) VALUES ($formats)";

	$this->check_current_query = false;
	return $this->query( $this->prepare( $sql, $values ) );

Top ↑


Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.