WP_Meta_Query::get_sql( string $type, string $primary_table, string $primary_id_column, object $context = null ): string[]|false
- Since
- 3.2.0
- Source
wp-includes/class-wp-meta-query.php:357
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
$typestring- Type of meta. Possible values include but are not limited to 'post', 'comment', 'blog', 'term', and 'user'.
$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.
$contextobjectoptional- The main query object that corresponds to the type, for example a
WP_Query,WP_User_Query, orWP_Site_Query.
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.
$joinstringSQL fragment to append to the main JOIN clause.$wherestringSQL fragment to append to the main WHERE clause.
Performance profile
How much work a call to WP_Meta_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
- Scaling
- Constant
- Instructions
- 10–46
- Plugin surface
- 1 hook
- Called by
- 0
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 47.
Third-party callbacks on 'get_meta_sql' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters_ref_array()called directly
What one call costs · 2 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() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10 | _get_meta_table() |
| always | 41–46 | _get_meta_table(), sanitize_key(), ->get_sql_clauses() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 47 | 10–46 | 2 | |
| 8.5 | 47 | 10–46 | 2 | |
| 8.4 | 47 | 10–46 | 2 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 53 | 10–52 | 2 | |
| 8.2 | 53 | 10–52 | 2 | |
| 8.1 | 53 | 10–52 | 2 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 54 | 10–53 | 2 |
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.
Hooks and filters fired · 1
One hook fires while WP_Meta_Query::get_sql() runs, in this order:
- apply_filters( get_meta_sql )filterline 395 (+38 into the body)
Filters the meta query's generated SQL.
Uses · 5
- _get_meta_table()Retrieves the name of the metadata table for the specified object type.
- sanitize_key()Sanitizes a string key.
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
- apply_filters_ref_array()Calls the callback functions that have been added to a filter hook, specifying arguments in an array.
- WP_Meta_Query::get_sql_clauses()Generates SQL clauses to be appended to a main query.
Source code
public function get_sql( $type, $primary_table, $primary_id_column, $context = null ) { $meta_table = _get_meta_table( $type ); if ( ! $meta_table ) { return false; } $this->table_aliases = array(); $this->meta_table = $meta_table; $this->meta_id_column = sanitize_key( $type . '_id' ); $this->primary_table = $primary_table; $this->primary_id_column = $primary_id_column; $sql = $this->get_sql_clauses(); /* * If any JOINs are LEFT JOINs (as in the case of NOT EXISTS), then all JOINs should * be LEFT. Otherwise posts with no metadata will be excluded from results. */ if ( str_contains( $sql['join'], 'LEFT JOIN' ) ) { $sql['join'] = str_replace( 'INNER JOIN', 'LEFT JOIN', $sql['join'] ); } /** * Filters the meta query's generated SQL. * * @since 3.1.0 * * @param string[] $sql Array containing the query's JOIN and WHERE clauses. * @param array $queries Array of meta queries. * @param string $type Type of meta. Possible values include but are not limited * to 'post', 'comment', 'blog', 'term', and 'user'. * @param string $primary_table Primary table. * @param string $primary_id_column Primary column ID. * @param object $context The main query object that corresponds to the type, for * example a `WP_Query`, `WP_User_Query`, or `WP_Site_Query`. */ return apply_filters_ref_array( 'get_meta_sql', array( $sql, $this->queries, $type, $primary_table, $primary_id_column, $context ) ); }Changelog
Introduced in 3.2.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 6.8.8 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.