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

Helper function for insert and replace.

Description Description

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

See also See also

Top ↑

Parameters Parameters


(string) (Required) Table name


(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.


(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


(string) (Optional) What type of operation is this? INSERT or REPLACE. Defaults to INSERT.

Default value: 'INSERT'

Top ↑

Return Return

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

Top ↑

Source Source

File: wp-includes/wp-db.php

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

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

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

		$formats = $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 ↑

Changelog Changelog

Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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