get_meta_sql() – Function | Developer.WordPress.org

Given a meta query, generates SQL clauses to be appended to a main query.

Description

Parameters

$meta_queryarrayrequired: A meta query.
$typestringrequired: Type of meta.
$primary_tablestringrequired: Primary database table name.
$primary_id_columnstringrequired: Primary ID column name.
$contextobjectoptional: The main query object.
Default:null

Return

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.

join string
SQL fragment to append to the main JOIN clause.
where string
SQL fragment to append to the main WHERE clause.

Source

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 );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Meta_Query::__construct()`wp-includes/class-wp-meta-query.php`	Constructor.

Changelog

Version	Description
3.2.0	Introduced.

User Contributed Notes

Codex 10 years ago

Example

<?php  
$meta_query = array(
	array(
		'key' => 'color',
		'value' => 'blue',
		'compare' => 'NOT LIKE'
	)
);
global $wpdb;
$meta_sql = get_meta_sql( $meta_query, 'post', $wpdb->posts, 'ID' );

Output depending on the meta query:

Array
(
    [join] =>  INNER JOIN wp_postmeta ON (wp_posts.ID = wp_postmeta.post_id)
    [where] =>  AND ( (wp_postmeta.meta_key = 'color' AND CAST(wp_postmeta.meta_value AS CHAR) NOT LIKE '%blue%') )
)

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

In this article