wppaste
WordPress

get_meta_sql( array $meta_query, string $type, string $primary_table, string $primary_id_column, object $context = null ): string[]|false

Since
3.2.0
Source
wp-includes/meta.php:1248
Given a meta query, generates SQL clauses to be appended to a main query.

Compatibility

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

$meta_queryarray
A meta query.
$typestring
Type of meta.
$primary_tablestring
Primary database table name.
$primary_id_columnstring
Primary ID column name.
$contextobjectoptional
The main query object. Default null.Default: null

Return value

string[]|false
Array containing JOIN and WHERE SQL clauses to append to the main query, or false if no table exists for the requested meta type.

  • $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 get_meta_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
16

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

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 get_meta_sql() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always16->get_sql()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 16 instructions, 16 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 

function get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null ) {	$meta_query_obj = new WP_Meta_Query( $meta_query );	return $meta_query_obj->get_sql( $type, $primary_table, $primary_id_column, $context );}

Changelog

Introduced in 3.2.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/meta.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.