WP_Date_Query::build_time_query( string $column, string $compare, int|null $hour = null, int|null $minute = null, int|null $second = null ): string|false
- Since
- 3.7.0
- Source
wp-includes/class-wp-date-query.php:983
Description
If just hour, minute, or second is set than a normal comparison will be done.
However if multiple values are passed, a pseudo-decimal time will be created in order to be able to accurately compare against.
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
$columnstring- The column to query against. Needs to be pre-validated!
$comparestring- The comparison operator. Needs to be pre-validated!
$hourint|nulloptional- An hour value (0-23).Default:
null $minuteint|nulloptional- A minute value (0-59).Default:
null $secondint|nulloptional- A second value (0-59).Default:
null
Return value
string|false- A query part or false on failure.
Performance profile
How much work a call to WP_Date_Query::build_time_query() 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
- Trivial
- Scaling
- Constant
- Instructions
- 13–77
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 164.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 9 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Date_Query::build_time_query() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!isset($minute) | 13–35 | none |
!$compare | 26–46 | ->build_value() |
$compare | 34–62 | ->build_value(), ->build_value(), ->build_value() |
!$compare && isset($minute) && $hour === null && !isset($second) | 42–58 | sprintf(), ->prepare() |
!$compare && isset($minute) | 48–64 | sprintf(), sprintf(), ->prepare() |
!$compare && $value === false && isset($minute) && $hour === null && !isset($second) | 49–65 | ->build_value(), sprintf(), ->prepare() |
!$compare && isset($minute) && $hour !== null && isset($second) | 54–70 | sprintf(), sprintf(), sprintf(), ->prepare() |
!$compare && $value === false && isset($minute) | 55–71 | ->build_value(), sprintf(), sprintf(), ->prepare() |
!$compare && isset($second) && $value === false && isset($minute) && $hour !== null | 61–77 | ->build_value(), sprintf(), sprintf(), sprintf(), ->prepare() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 164 | 13–77 | 22 | |
| 8.5 | 164 | 13–77 | 22 | |
| 8.4 | 164 | 13–77 | 22 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 167 | 13–77 | 22 | |
| 8.2 | 167 | 13–77 | 22 | |
| 8.1 | 167 | 13–77 | 22 | |
| 7.4 | 167 | 13–77 | 22 |
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 · 1
- WP_Date_Query::build_value()Builds and validates a value string based on the comparison operator.
Used by · 1
- WP_Date_Query::get_sql_for_clause()Turns a first-order date query into SQL for a WHERE clause.
Source code
public function build_time_query( $column, $compare, $hour = null, $minute = null, $second = null ) { global $wpdb; // Have to have at least one. if ( ! isset( $hour ) && ! isset( $minute ) && ! isset( $second ) ) { return false; } // Complex combined queries aren't supported for multi-value queries. if ( in_array( $compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ), true ) ) { $return = array(); $value = $this->build_value( $compare, $hour ); if ( false !== $value ) { $return[] = "HOUR( $column ) $compare $value"; } $value = $this->build_value( $compare, $minute ); if ( false !== $value ) { $return[] = "MINUTE( $column ) $compare $value"; } $value = $this->build_value( $compare, $second ); if ( false !== $value ) { $return[] = "SECOND( $column ) $compare $value"; } return implode( ' AND ', $return ); } // Cases where just one unit is set. if ( isset( $hour ) && ! isset( $minute ) && ! isset( $second ) ) { $value = $this->build_value( $compare, $hour ); if ( false !== $value ) { return "HOUR( $column ) $compare $value"; } } elseif ( ! isset( $hour ) && isset( $minute ) && ! isset( $second ) ) { $value = $this->build_value( $compare, $minute ); if ( false !== $value ) { return "MINUTE( $column ) $compare $value"; } } elseif ( ! isset( $hour ) && ! isset( $minute ) && isset( $second ) ) { $value = $this->build_value( $compare, $second ); if ( false !== $value ) { return "SECOND( $column ) $compare $value"; } } // Single units were already handled. Since hour & second isn't allowed, minute must to be set. if ( ! isset( $minute ) ) { return false; } $format = ''; $time = ''; // Hour. if ( null !== $hour ) { $format .= '%H.'; $time .= sprintf( '%02d', $hour ) . '.'; } else { $format .= '0.'; $time .= '0.'; } // Minute. $format .= '%i'; $time .= sprintf( '%02d', $minute ); if ( isset( $second ) ) { $format .= '%s'; $time .= sprintf( '%02d', $second ); } return $wpdb->prepare( "DATE_FORMAT( $column, %s ) $compare %f", $format, $time ); }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 7.1.0 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.