wpdb::process_fields( string $table, array $data, string[]|string $format ): array|false
- Since
- 4.2.0
- Source
wp-includes/class-wpdb.php:2806
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.
Compatibility
- WordPress
- since 4.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$tablestring- Table name.
$dataarray- Array of values keyed by their field names.
$formatstring[]|string- Formats or format to be mapped to the values in the data.
Return value
array|false- An array of fields that contain paired value and formats.
False for invalid values.
Performance profile
How much work a call to wpdb::process_fields() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Light
- Scaling
- Scales with input
- Instructions
- 11–52
- Plugin surface
- None
- Called by
- 3
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 74.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wpdb::process_fields() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$data === false | 11 | ->process_field_formats() |
| always | 18 | ->process_field_formats(), ->process_field_charsets() |
| always | 25 | ->process_field_formats(), ->process_field_charsets(), ->process_field_lengths() |
| always | 31 | ->process_field_formats(), ->process_field_charsets(), ->process_field_lengths(), ->strip_invalid_text() |
$data !== false | 49–50 | ->process_field_formats(), ->process_field_charsets(), ->process_field_lengths(), ->strip_invalid_text(), wp_load_translations_early(), __(), sprintf() |
$data !== false | 51–52 | ->process_field_formats(), ->process_field_charsets(), ->process_field_lengths(), ->strip_invalid_text(), wp_load_translations_early(), __(), reset(), sprintf() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 74 | 11–52 | 8 | |
| 8.5 | 74 | 11–52 | 8 | |
| 8.4 | 74 | 11–52 | 8 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 77 | 11–53 | 8 | |
| 8.2 | 77 | 11–53 | 8 | |
| 8.1 | 77 | 11–53 | 8 | |
| 7.4 | 77 | 11–53 | 8 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 6
- wp_load_translations_early()Attempts an early load of translations.
- __()Retrieves the translation of $text.
- wpdb::process_field_formats()Prepares arrays of value/format pairs as passed to wpdb CRUD methods.
- wpdb::process_field_charsets()Adds field charsets to field/value/format arrays generated by wpdb::process_field_formats().
- wpdb::process_field_lengths()For string fields, records the maximum string length that field can safely save.
- wpdb::strip_invalid_text()Strips any invalid characters based on value/charset pairs.
Used by · 3
- wpdb::_insert_replace_helper()Helper function for insert and replace.
- wpdb::delete()Deletes a row in the table.
- wpdb::update()Updates a row in the table.
Source code
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
Introduced in 4.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 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.