wpdb::process_fields( string $table, array $data, string[]|string $format ): array|false

Processes arrays of field/value pairs and field formats.

Description

This is a helper method for wpdb’s CRUD methods, which take field/value pairs for inserts, updates, and where clauses. This method first pairs each value with a format. Then it determines the charset of that field, using that to determine if any invalid text would be stripped. If text is stripped, then field processing is rejected and the query fails.

Parameters

$tablestringrequired
Table name.
$dataarrayrequired
Array of values keyed by their field names.
$formatstring[]|stringrequired
Formats or format to be mapped to the values in the data.

Return

array|false An array of fields that contain paired value and formats.
False for invalid values.

Source

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

	$data = $this->process_field_charsets( $data, $table );
	if ( false === $data ) {
		return false;
	}

	$data = $this->process_field_lengths( $data, $table );
	if ( false === $data ) {
		return false;
	}

	$converted_data = $this->strip_invalid_text( $data );

	if ( $data !== $converted_data ) {

		$problem_fields = array();
		foreach ( $data as $field => $value ) {
			if ( $value !== $converted_data[ $field ] ) {
				$problem_fields[] = $field;
			}
		}

		wp_load_translations_early();

		if ( 1 === count( $problem_fields ) ) {
			$this->last_error = sprintf(
				/* translators: %s: Database field where the error occurred. */
				__( 'WordPress database error: Processing the value for the following field failed: %s. The supplied value may be too long or contains invalid data.' ),
				reset( $problem_fields )
			);
		} else {
			$this->last_error = sprintf(
				/* translators: %s: Database fields where the error occurred. */
				__( 'WordPress database error: Processing the values for the following fields failed: %s. The supplied values may be too long or contain invalid data.' ),
				implode( ', ', $problem_fields )
			);
		}

		return false;
	}

	return $data;
}

Changelog

VersionDescription
4.2.0Introduced.

User Contributed Notes

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