WP_Meta_Query::get_sql_for_clause( array $clause, array $parent_query, string $clause_key = '' ): array

Description

Compatibility

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

Parameters

$clausearray

Query clause (passed by reference).

$parent_queryarray

Parent query array.

$clause_keystringoptional

The array key used to name the clause in the original $meta_query parameters. If not provided, a key will be generated automatically.
Default empty string.Default: ''

Return value

array

Array containing JOIN and WHERE SQL clauses to append to a first-order 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_Meta_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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

68–131

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• regexregular expression over the whole inputpreg_split()called directly

What one call costs · 11 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 2

• WP_Meta_Query::find_compatible_table_alias()Identifies an existing table alias that is compatible with the current query clause.
• WP_Meta_Query::get_cast_for_type()Returns the appropriate alias for the given meta type if applicable.

Used by · 1

• WP_Meta_Query::get_sql_for_query()Generates SQL clauses for a single query array.

Source code

View on Trac ↗View on GitHub ↗

533	public function get_sql_for_clause( &$clause, $parent_query, $clause_key = '' ) {534		global $wpdb;535 536		$sql_chunks = array(537			'where' => array(),538			'join'  => array(),539		);540 541		if ( isset( $clause['compare'] ) ) {542			$clause['compare'] = strtoupper( $clause['compare'] );543		} else {544			$clause['compare'] = isset( $clause['value'] ) && is_array( $clause['value'] ) ? 'IN' : '=';545		}546 547		$non_numeric_operators = array(548			'=',549			'!=',550			'LIKE',551			'NOT LIKE',552			'IN',553			'NOT IN',554			'EXISTS',555			'NOT EXISTS',556			'RLIKE',557			'REGEXP',558			'NOT REGEXP',559		);560 561		$numeric_operators = array(562			'>',563			'>=',564			'<',565			'<=',566			'BETWEEN',567			'NOT BETWEEN',568		);569 570		if ( ! in_array( $clause['compare'], $non_numeric_operators, true ) && ! in_array( $clause['compare'], $numeric_operators, true ) ) {571			$clause['compare'] = '=';572		}573 574		if ( isset( $clause['compare_key'] ) ) {575			$clause['compare_key'] = strtoupper( $clause['compare_key'] );576		} else {577			$clause['compare_key'] = isset( $clause['key'] ) && is_array( $clause['key'] ) ? 'IN' : '=';578		}579 580		if ( ! in_array( $clause['compare_key'], $non_numeric_operators, true ) ) {581			$clause['compare_key'] = '=';582		}583 584		$meta_compare     = $clause['compare'];585		$meta_compare_key = $clause['compare_key'];586 587		// First build the JOIN clause, if one is required.588		$join = '';589 590		// We prefer to avoid joins if possible. Look for an existing join compatible with this clause.591		$alias = $this->find_compatible_table_alias( $clause, $parent_query );592		if ( false === $alias ) {593			$i     = count( $this->table_aliases );594			$alias = $i ? 'mt' . $i : $this->meta_table;595 596			// JOIN clauses for NOT EXISTS have their own syntax.597			if ( 'NOT EXISTS' === $meta_compare ) {598				$join .= " LEFT JOIN $this->meta_table";599				$join .= $i ? " AS $alias" : '';600 601				if ( 'LIKE' === $meta_compare_key ) {602					$join .= $wpdb->prepare( " ON ( $this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column AND $alias.meta_key LIKE %s )", '%' . $wpdb->esc_like( $clause['key'] ) . '%' );603				} else {604					$join .= $wpdb->prepare( " ON ( $this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column AND $alias.meta_key = %s )", $clause['key'] );605				}606 607				// All other JOIN clauses.608			} else {609				$join .= " INNER JOIN $this->meta_table";610				$join .= $i ? " AS $alias" : '';611				$join .= " ON ( $this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column )";612			}

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.0.4 tag, from src/wp-includes/class-wp-meta-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.