WP_Date_Query::build_value( string $compare, string|array $value ): string|false|int
- Since
- 3.7.0
- Source
wp-includes/class-wp-date-query.php:813
Compatibility
- WordPress
- since 3.7.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
$comparestring- The compare operator to use.
$valuestring|array- The value.
Return value
string|false|int- The value to be used in SQL or false on error.
Performance profile
How much work a call to WP_Date_Query::build_value() 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
- 5–35
- Plugin surface
- None
- Called by
- 2
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 68.
Nothing here hands control to plugin code.
2 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 WP_Date_Query::build_value() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 5–28 | none |
isset($value) && empty($value) | 15–19 | array_filter() |
isset($value) && is_array($value) && !$value && !$v | 20–28 | array_values() |
isset($value) && !empty($value) | 22–26 | array_filter(), array_map() |
isset($value) | 23–35 | array_map() |
isset($value) && is_array($value) | 26–35 | array_values(), array_map() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 68 | 5–35 | 13 | |
| 8.5 | 68 | 5–35 | 13 | |
| 8.4 | 68 | 5–35 | 13 | 7 fewer instructions than PHP 8.3 |
| 8.3 | 75 | 5–35 | 13 | |
| 8.2 | 75 | 5–35 | 13 | 1 more instruction than PHP 8.1 |
| 8.1 | 74 | 5–35 | 13 | |
| 7.4 | 74 | 5–35 | 13 |
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.
Used by · 2
- WP_Date_Query::build_time_query()Builds a query string for comparing time values (hour, minute, second).
- WP_Date_Query::get_sql_for_clause()Turns a first-order date query into SQL for a WHERE clause.
Source code
public function build_value( $compare, $value ) { if ( ! isset( $value ) ) { return false; } switch ( $compare ) { case 'IN': case 'NOT IN': $value = (array) $value; // Remove non-numeric values. $value = array_filter( $value, 'is_numeric' ); if ( empty( $value ) ) { return false; } return '(' . implode( ',', array_map( 'intval', $value ) ) . ')'; case 'BETWEEN': case 'NOT BETWEEN': if ( ! is_array( $value ) || 2 !== count( $value ) ) { $value = array( $value, $value ); } else { $value = array_values( $value ); } // If either value is non-numeric, bail. foreach ( $value as $v ) { if ( ! is_numeric( $v ) ) { return false; } } $value = array_map( 'intval', $value ); return $value[0] . ' AND ' . $value[1]; default: if ( ! is_numeric( $value ) ) { return false; } return (int) $value; } }Changelog
Introduced in 3.7.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-wp-date-query.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.