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

Description

Parameters

$tablestring

Table name.

$dataarray

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.

$formatstring[]|stringoptional

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.Default: null

$typestringoptional

Type of operation. Either 'INSERT' or 'REPLACE'. Default 'INSERT'.Default: 'INSERT'

Return

int|false

The number of rows affected, or false on error.

Uses · 3

• wpdb::process_fields()Processes arrays of field/value pairs and field formats.
• wpdb::query()Performs a database query, using current database connection.
• wpdb::prepare()Prepares a SQL query for safe execution.

Used by · 2

• wpdb::insert()Inserts a row into the table.
• wpdb::replace()Replaces a row in the table or inserts it if it does not exist, based on a PRIMARY KEY or a UNIQUE index.

Source

View on Trac ↗View on GitHub ↗

2584	public function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {2585		$this->insert_id = 0;2586 2587		if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ), true ) ) {2588			return false;2589		}2590 2591		$data = $this->process_fields( $table, $data, $format );2592		if ( false === $data ) {2593			return false;2594		}2595 2596		$formats = array();2597		$values  = array();2598		foreach ( $data as $value ) {2599			if ( is_null( $value['value'] ) ) {2600				$formats[] = 'NULL';2601				continue;2602			}2603 2604			$formats[] = $value['format'];2605			$values[]  = $value['value'];2606		}2607 2608		$fields  = '`' . implode( '`, `', array_keys( $data ) ) . '`';2609		$formats = implode( ', ', $formats );2610 2611		$sql = "$type INTO `$table` ($fields) VALUES ($formats)";2612 2613		$this->check_current_query = false;2614		return $this->query( $this->prepare( $sql, $values ) );2615	}

History

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/class-wpdb.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.