get_meta_sql │ filter-hook │ WP 3.1.0

Filters the meta query's generated SQL.

Usage

add_filter( 'get_meta_sql', 'wp_kama_get_meta_sql_filter', 10, 6 );

/**
 * Function for `get_meta_sql` filter-hook.
 * 
 * @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 string[]
 */
function wp_kama_get_meta_sql_filter( $sql, $queries, $type, $primary_table, $primary_id_column, $context ){

	// filter...
	return $sql;
}

$sql(string[])

Array containing the query's JOIN and WHERE clauses.

$queries(array)

Array of meta queries.

$type(string)

Type of meta. Possible values include but are not limited to 'post', 'comment', 'blog', 'term', and 'user'.

$primary_table(string)

Primary table.

$primary_id_column(string)

Primary column ID.

$context(object)

The main query object that corresponds to the type, for example a WP_Query, WP_User_Query, or WP_Site_Query.

Changelog

Where the hook is called

return apply_filters_ref_array( 'get_meta_sql', array( $sql, $this->queries, $type, $primary_table, $primary_id_column, $context ) );

Where the hook is used in WordPress