wpdb::update( string $table, array $data, array $where, string[]|string $format = null, string[]|string $where_format = null ): int|false

Description

Parameters

$tablestring

Table name.

$dataarray

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.

$wherearray

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.

$formatstring[]|stringoptional

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

$where_formatstring[]|stringoptional

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

Return

int|false

The number of rows updated, 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.

Source

View on Trac ↗View on GitHub ↗

2680	public function update( $table, $data, $where, $format = null, $where_format = null ) {2681		if ( ! is_array( $data ) || ! is_array( $where ) ) {2682			return false;2683		}2684 2685		$data = $this->process_fields( $table, $data, $format );2686		if ( false === $data ) {2687			return false;2688		}2689		$where = $this->process_fields( $table, $where, $where_format );2690		if ( false === $where ) {2691			return false;2692		}2693 2694		$fields     = array();2695		$conditions = array();2696		$values     = array();2697		foreach ( $data as $field => $value ) {2698			if ( is_null( $value['value'] ) ) {2699				$fields[] = "`$field` = NULL";2700				continue;2701			}2702 2703			$fields[] = "`$field` = " . $value['format'];2704			$values[] = $value['value'];2705		}2706		foreach ( $where as $field => $value ) {2707			if ( is_null( $value['value'] ) ) {2708				$conditions[] = "`$field` IS NULL";2709				continue;2710			}2711 2712			$conditions[] = "`$field` = " . $value['format'];2713			$values[]     = $value['value'];2714		}2715 2716		$fields     = implode( ', ', $fields );2717		$conditions = implode( ' AND ', $conditions );2718 2719		$sql = "UPDATE `$table` SET $fields WHERE $conditions";2720 2721		$this->check_current_query = false;2722		return $this->query( $this->prepare( $sql, $values ) );2723	}

History

Introduced in 2.5.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.1.0 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.