wppaste
WordPress

WP_Tax_Query::get_sql( string $primary_table, string $primary_id_column ): string[]

Since
3.1.0
Source
wp-includes/class-wp-tax-query.php:247
Generates SQL clauses to be appended to a main query.

Compatibility

WordPress
since 3.1.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

$primary_tablestring
Database table where the object being filtered is stored (eg wp_users).
$primary_id_columnstring
ID column for the filtered object in $primary_table.

Return value

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

  • $joinstring

    SQL fragment to append to the main JOIN clause.

  • $wherestring

    SQL fragment to append to the main WHERE clause.

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
9

Executed per call on PHP 8.5. The body compiles to 9.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always9->get_sql_clauses()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 9 instructions, 9 executed per call, 0 branches. The work does not change between versions.

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

Source code

View on Trac View on GitHub 

	public function get_sql( $primary_table, $primary_id_column ) {		$this->primary_table     = $primary_table;		$this->primary_id_column = $primary_id_column; 		return $this->get_sql_clauses();	}

Changelog

Introduced in 3.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 6.7.7 tag, from src/wp-includes/class-wp-tax-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.