WP_Date_Query::get_sql_for_clause( array $query, array $parent_query ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$queryarray

Date query clause.

$parent_queryarray

Parent query of the current date query.

Return value

array

Array containing JOIN and WHERE SQL clauses to append to the main query.

• $joinstring[]

  Array of SQL fragments to append to the main JOIN clause.

• $wherestring[]

  Array of SQL fragments to append to the main WHERE clause.

Performance profile

How much work a call to WP_Date_Query::get_sql_for_clause() 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

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

36–98

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 155.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()one call below WP_Date_Query::get_sql_for_clause()

Further down the call graph this can also reach hook, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 12 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Date_Query::get_sql_for_clause() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• esc_sql()Escapes data for use in a MySQL query.
• _wp_mysql_week()Returns a MySQL expression for selecting the week number based on the start_of_week option.
• WP_Date_Query::validate_column()Validates a column name parameter.
• WP_Date_Query::get_compare()Determines and validates what comparison operator to use.
• WP_Date_Query::build_mysql_datetime()Builds a MySQL format date/time based on some query parameters.
• WP_Date_Query::build_value()Builds and validates a value string based on the comparison operator.
• WP_Date_Query::build_time_query()Builds a query string for comparing time values (hour, minute, second).

Used by · 2

• WP_Date_Query::get_sql_for_query()Generates SQL clauses for a single query array.
• WP_Date_Query::get_sql_for_subquery()Turns a single date clause into pieces for a WHERE clause.

Source code

View on Trac ↗View on GitHub ↗

721	protected function get_sql_for_clause( $query, $parent_query ) {722		global $wpdb;723 724		// The sub-parts of a $where part.725		$where_parts = array();726 727		$column = ( ! empty( $query['column'] ) ) ? esc_sql( $query['column'] ) : $this->column;728 729		$column = $this->validate_column( $column );730 731		$compare = $this->get_compare( $query );732 733		$inclusive = ! empty( $query['inclusive'] );734 735		// Assign greater- and less-than values.736		$lt = '<';737		$gt = '>';738 739		if ( $inclusive ) {740			$lt .= '=';741			$gt .= '=';742		}743 744		// Range queries.745		if ( ! empty( $query['after'] ) ) {746			$where_parts[] = $wpdb->prepare( "$column $gt %s", $this->build_mysql_datetime( $query['after'], ! $inclusive ) );747		}748		if ( ! empty( $query['before'] ) ) {749			$where_parts[] = $wpdb->prepare( "$column $lt %s", $this->build_mysql_datetime( $query['before'], $inclusive ) );750		}751		// Specific value queries.752 753		$date_units = array(754			'YEAR'           => array( 'year' ),755			'MONTH'          => array( 'month', 'monthnum' ),756			'_wp_mysql_week' => array( 'week', 'w' ),757			'DAYOFYEAR'      => array( 'dayofyear' ),758			'DAYOFMONTH'     => array( 'day' ),759			'DAYOFWEEK'      => array( 'dayofweek' ),760			'WEEKDAY'        => array( 'dayofweek_iso' ),761		);762 763		// Check of the possible date units and add them to the query.764		foreach ( $date_units as $sql_part => $query_parts ) {765			foreach ( $query_parts as $query_part ) {766				if ( isset( $query[ $query_part ] ) ) {767					$value = $this->build_value( $compare, $query[ $query_part ] );768					if ( $value ) {769						switch ( $sql_part ) {770							case '_wp_mysql_week':771								$where_parts[] = _wp_mysql_week( $column ) . " $compare $value";772								break;773							case 'WEEKDAY':774								$where_parts[] = "$sql_part( $column ) + 1 $compare $value";775								break;776							default:777								$where_parts[] = "$sql_part( $column ) $compare $value";778						}779 780						break;781					}782				}783			}784		}785 786		if ( isset( $query['hour'] ) || isset( $query['minute'] ) || isset( $query['second'] ) ) {787			// Avoid notices.788			foreach ( array( 'hour', 'minute', 'second' ) as $unit ) {789				if ( ! isset( $query[ $unit ] ) ) {790					$query[ $unit ] = null;791				}792			}793 794			$time_query = $this->build_time_query( $column, $compare, $query['hour'], $query['minute'], $query['second'] );795			if ( $time_query ) {796				$where_parts[] = $time_query;797			}798		}799 800		/*

Changelog

Introduced in 4.1.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-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.