WordPress как на ладони
wordpress jino

WP_Meta_Query{} WP 3.2.0 WP Meta Query{}

Класс создает JOIN и WHERE части SQL запроса, которые в дополнении к основному запросу будут фильтровать результат по указанным ключу и значению метаполя.

WP_Meta_Query - это вспомогательный класс, который используется в комбинации с классами: WP_Query, WP_User_Query, WP_Comment_Query и помогает им фильтровать результат на основе указанных метаданных.

Для WP_Meta_Query есть функция-обертка: get_meta_sql()

Оглавление:
Используется в: get_meta_sql().
✈ 1 раз = 0.000264с = быстро | 50000 раз = 5.41с = быстро
Хуки из класса:
Возвращает

Ничего не возвращает. Создает объект.

Аргументы параметра $meta_query

$meta_query передается в класс и на основе этих данных строятся части запроса.

$meta_query это массив, где каждый элемент является массивом с параметрами отдельного запроса, т.е. это массив массивов. Такая конструкция позволяет создавать множественные запросы. Вот как это выглядит:

$meta_query = array(
	'relation' => 'OR', // по умолчанию 'AND'

	// Первый мета запрос
	'Ключ для orderby' => array(
		'key'     => 'color',
		'value'   => 'blue',
		'compare' => '!=', // по умолчанию '='
	),

	// Второй мета запрос
	array(
		'key'     => 'price',
		'value'   => 20,
		'compare' => '>',
		'type'    => 'NUMERIC', // по умолчанию 'CHAR'
	),

	// Третий мета запрос. и т.д...
);

Если указать ключ для вложенного массива, то этот ключ можно использовать в параметре 'orderby' в родительском запросе для сортировки по текущему метаполю.

relation(строка)

Определяет логическую связь между вложенными массивами. Может быть:

  • OR - выбрать мета-поля подходящие хоты бы под один массив параметров;
  • AND (по умолчанию) - выбрать мета поля подходящие для всех массивов параметров.

    • key (строка)
      Ключ поля.

    • value (строка/массив)
      Значение поля. Указывать не нужно, если при сравнении используется: EXISTS или NOT EXISTS (с версии 3.9).

    • compare (строка)
      Как сравнивать указанное в value значение.
      Может быть: 

      • = - равно.
      • != - не равно.
      • > - больше.
      • >= - больше или равно.
      • < - меньше.
      • <= - меньше или равно.
      • LIKE - указанная в value подстрока имеется в строке. Как '%значение%' в sql запросе.
      • NOT LIKE - тоже что LIKE только наоборот.
      • IN - в value указываются несколько значений в массиве и поиск идет хотя бы по одному из значений.
      • NOT IN - любое значение, кроме тех что указанны в виде массива в value.
      • BETWEEN - в value указываются 2 значения в массиве: большее и меньшее и поиск идет между этих значений. , например: 'value' => array(5, 25) - от 5 до 25 (включительно).
      • NOT BETWEEN - любое значение, за пределами диапазона указанного в value, например: 'value' => array(5, 25) - меньше 5 и больше 25.
      • EXISTS - выведет всё где существует указанный в 'key' ключ. 'value' не указывается в этом случае. (с версии 3.5)
      • NOT EXISTS - выведет всё где указанный в 'key' ключ не существует. 'value' не указывается в этом случае. (с версии 3.5)
      • REGEXP - в value указывается регулярное выражение для поиска, например: 'value' => '^bar', (найдет строку: 'bar is'). (с версии 3.7)
      • NOT REGEXP - в value указывается регулярное выражение для поиска, найдет все что не входит в это выражение. (с версии 3.7)
      • RLIKE - синоним REGEXP. (с версии 3.7)

    По умолчанию 'IN', если value массив, '=' в других случаях.

    • type (строка)
      Тип данных в который нужно перевести value для сравнения (использует mysql CAST). Если, например, в поле указываются только числа то нужно использовать NUMERIC, чтобы числа не сравнивались как строки. Может быть:

      • NUMERIC - целые числа.
      • DECIMAL - дробные числа. Можно указать точность: DECIMAL(p,s). Например: DECIMAL(5,2) - число с макс 5 цифрами всего (3 до разделителя) и 2 цифры после разделителя.
      • SIGNED - целые числа, положительные и отрицательные
      • UNSIGNED - целые числа, только положительные
      • CHAR - строка не чувствительна к регистру
      • BINARY - строка чувствительная к регистру
      • DATETIME - дата и время
      • DATE - только дата
      • TIME - только время
        По умолчанию: CHAR.

    Тип DATE работает при сравнении BETWEEN только если дата указывается в формате YYYY-MM-DD и сравнивается с аналогичным форматом.

к началу

Использование

Есть 2 варианта передать параметры в класс:

#1. Передача параметров в конструктор

В этом случае, мы передаем массив параметров в сам класс.

$meta_query = array(
	'relation' => 'OR', // не обязательно, по умолчанию 'AND'
	array(
		'key'     => 'key_name',
		'value'   => 'значение поля',
		'compare' => '=' // не обязательно, по умолчанию '=' или 'IN' (если value массив)
	)
);

$mq = new WP_Meta_Query( $meta_query );

#2. Передача параметров в метод parse_query_vars()

parse_query_vars() нужен, когда используется "простой" способ передачи параметров: в виде одномерного массива. Или если вы не уверены как будут передаваться параметры и они могут передаваться в виде одномерного массива.

В этом случае каждый параметр может начинаться с 'meta_*' и такой параметр должен быть в первом массиве:

$meta_query = array(
	'relation' => 'OR',

	'meta_key'     => 'ключ',
	'meta_value'   => 'значение',
	'meta_type'    => 'CHAR',
	'meta_compare' => '!=',

	// тут может быть еще один вложенный массив параметров
	array(
		'key'     => 'ключ',
		'value'   => 'значение',
	)
)

$mq = new WP_Meta_Query();
$mq->parse_query_vars( $meta_query );

Получение SQL запроса

После того как параметры переданы, мы можем получить SQL запрос с помощью метода get_sql():

$mq_sql = $mq->get_sql( $type, $primary_table, $primary_id_column, $context );
$type(строка) (обязательный)
Тип метаданных. Например: 'user', 'post', 'comment'.
В объекте $wpdb должна быть зарегистрирована таблица с названием: $type .'meta', например, если мы укажем тут 'foo' то должна существовать таблица $wpdb->foometa. Если такой таблицы нет, то этот класс работать не будет!
$primary_table(строка) (обязательный)
Название основной таблицы, к которой относится таблица метаданных. Например wp_posts, wp_comments, wp_users.
$primary_id_column(строка) (обязательный)
Название ключевой колонки основной таблицы, указанной в $primary_table. Для wp_posts - ID, для wp_users - ID, для wp_comments - comment_ID.
$context(объект)
Объект основного запроса. Этот параметр нигде не используется, а передается в фильтр get_meta_sql.
По умолчанию: null

Если по каким-либо причинам функция не смогла создать правильный запрос, то она вернет false.

В остальных случаях, вернется массив такого вида:

array(
	'join'  => 'JOIN SQL строка',
	'where' => 'WHERE SQL строка'
)
к началу

Примеры

#1 Демонстрация использования

$meta_query = array(
	'relation' => 'OR', // не обязательно, по умолчанию 'AND'
	array(
		'key'     => 'key_name',
		'value'   => 'значение поля',
		'compare' => '=' // не обязательно, по умолчанию '=' или 'IN' (если value массив)
	)
);

$query_obj = new WP_Meta_Query( $meta_query );

$mq_sql = $query_obj->get_sql( 'post', 'wp_posts', 'ID' );

// используем в основном запросе
$mq_sql['join'];
$mq_sql['where'];

В результате $mq_sql будет содержать:

Array
(
	[join] =>  INNER JOIN wp_postmeta ON ( wp_posts.ID = wp_postmeta.post_id )
	[where] =>  AND ( 
		( wp_postmeta.meta_key = 'key_name' AND CAST(wp_postmeta.meta_value AS CHAR) = 'значение поля' )
	)
)

#2 Запрос с одномерным массивом $meta_query

В $meta_query можно указывать данные запроса не как вложенный массив, а сразу в текущем массиве. Такие данные надо предварять 'meta_*' и передавать их нужно в метод parse_query_vars( $meta_query );:

Этот пример создаст запрос только на основе ключа. Если нужен полный запрос добавьте meta_value и meta_compare:

global $wpdb;

$meta_query = array(
	'meta_key' => 'some_key_name',
);
$mq_obj = new WP_Meta_Query();

$mq_obj->parse_query_vars( $meta_query );

$mq_sql = $mq_obj->get_sql( 'post', $wpdb->posts, 'ID' );

$mq_sql будет содержать:

Array
(
	[join] =>  INNER JOIN wp_postmeta ON ( wp_posts.ID = wp_postmeta.post_id )
	[where] =>  AND ( wp_postmeta.meta_key = 'some_key_name' )
)

#3 Сложный запрос с многомерным массивом $meta_query

Этот пример показывает как WP_Meta_Query обрабатывает переменную 'meta_query', которая указанна в общих параметрах массива и содержит данные мета запросов.

$args = array(
	'post_type' => 'mypost', 
	'meta_query' => array(
		'relation' => 'OR',
		array(
			'key' => 'foo_key',
			'value' => 'foo',
			'compare' => 'LIKE',
		),
		array(
			'key' => 'bar_key',
		),
	)
);
$meta_query = new WP_Meta_Query();

$meta_query->parse_query_vars( $args );

$mq_sql = $meta_query->get_sql( 'post', $wpdb->posts, 'ID' );

В результате $mq_sql будет содержать:

Array
(
	[join] =>  INNER JOIN wp_postmeta ON ( wp_posts.ID = wp_postmeta.post_id )
	[where] =>  AND ( 
		( wp_postmeta.meta_key = 'foo_key' AND CAST(wp_postmeta.meta_value AS CHAR) LIKE '%foo%' ) 
		OR 
		wp_postmeta.meta_key = 'bar_key'
	)
)

#4 Сложный многоуровневый запрос

Кроме вложенных массивов, можно задавать и две вложенности при этом изменяя оператор relation, тем самым влияя на зависимость условий.

Например, нам нужно получить мешки серого цвета, весом 200кг, в которых находится бетон или материал не указан:

$args = array(
	'post_type' => 'mypost', 
	'meta_query' => array(
		'relation' => 'AND', // это по умолчанию - тут для наглядности...
		array(
			'relation' => 'OR',
			array(
				'key' => 'material',
				'value' => 'бетон',
			),
			array(
				'key' => 'material',
				'compare' => 'NOT EXISTS'
			),  
		),
		array(
			'key' => 'color',
			'value' => 'серый',
		),
		array(
			'key' => 'weight',
			'value' => '200',
		),
	)
);
$meta_query = new WP_Meta_Query();

$meta_query->parse_query_vars( $args );

$mq_sql = $meta_query->get_sql( 'post', $wpdb->posts, 'ID' );

$mq_sql будет содержать:

Array
(
	[join] =>  LEFT JOIN wp_postmeta ON ( wp_posts.ID = wp_postmeta.post_id )
			   LEFT JOIN wp_postmeta AS mt1 ON (wp_posts.ID = mt1.post_id AND mt1.meta_key = 'material' )  
			   LEFT JOIN wp_postmeta AS mt2 ON ( wp_posts.ID = mt2.post_id )
			   LEFT JOIN wp_postmeta AS mt3 ON ( wp_posts.ID = mt3.post_id )
	[where] =>  AND ( 
  ( 
	( wp_postmeta.meta_key = 'material' AND wp_postmeta.meta_value = 'бетон' ) 
	OR 
	mt1.post_id IS NULL
  ) 
  AND 
  ( mt2.meta_key = 'color' AND mt2.meta_value = 'серый' ) 
  AND 
  ( mt3.meta_key = 'weight' AND mt3.meta_value = '200' )
)
)

#5 Еще примеры

Можно посмотреть в описании параметра meta_query в WP_Query.

к началу

Заметки

  1. Результат не добавляет пробелы по краям строк к JOIN и WHERE. Поэтому вам нужно добавить пробелы вручную, чтобы не повредить SQL запрос.

  2. Если вы используете value и compare, то результат WHERE запроса будет выглядеть как-то так:
    AND (wp_postmeta.meta_key = 'foo_key' OR  (mt1.meta_key = 'bar_key' AND CAST(mt1.meta_value AS CHAR) LIKE '%foo%') )

    Обратите внимание, что mt1 здесь - это алиас мета таблицы, а значит wp_postmeta.meta_key и mt1 это разные таблицы. Поэтому в JOIN части вам нужно два раза объединить мета таблицы с основной, выглядит это так:

    INNER JOIN wp_postmeta ON wp_posts.ID = wp_postmeta.post_id INNER JOIN wp_postmeta AS mt1 ON (wp_posts.ID = mt1.post_id)
к началу

Свойства класса

$queries(массив)
Содержит параметры запроса $meta_query. См. описание параметров $meta_query.
$relation(строка)
Связь между несколькими указанными параметрами запросов. Может быть 'AND' или 'OR'.
$meta_table(строка)
Название таблицы метаданных. Например: wp_postmeta.
$meta_id_column(строка)
Название ключевой колонки мета таблицы, указанной в $meta_table. Пр. meta_id или umeta_id (users).
$primary_table(строка)
Название основной таблицы, к которой относится таблица метаданных. Например wp_posts, wp_comments, wp_users.
$primary_id_column(строка)
Название ключевой колонки основной таблицы, указанной в $primary_table. Для wp_posts - ID, для wp_users - ID, для wp_comments - comment_ID.
$table_aliases(массив) (protected)
Служебное свойство. Список альтернативных названий таблиц используемых в JOIN.
$clauses(массив) (protected)
Служебное свойство. Список отдельных частей запроса. В ключе указывается 'name'.
$has_or_relation(логический) (protected)
Служебное свойство. Содержит ли запрос хоть одну OR связь.
По умолчанию: false
к началу

Методы класса

__construct( $meta_query = false )
Конструктор.
Возвращает: ничего
sanitize_query( $queries )
Проверяет передаваемые параметры 'meta_query'. Исправляет из если надо: убирает пустые значения у проверяет что параметр 'relation' установлен.
Возвращает: чистый массив параметров.
is_first_order_clause( $query )
(protected)
Проверяет является ли установленный в параметрах запрос первым мета запросом. Первым считается любая первая группа параметров с ключом key или value. В $query передаются параметры.
Возвращает: true/false
parse_query_vars( $qv )
Исправляет параметры на стандартные на основе переданных meta_* параметров. $qv - массив параметров запроса.
Возвращает: ничего
get_cast_for_type( $type = '' )
Получает соответствующее альт. название для переданного типа, если есть. $type - строка тип в который нужно перевести value.
Возвращает: строку, MySQL тип
get_sql( $type, $primary_table, $primary_id_column, $context = null )
Создает части SQL запроса на основе установленных параметров, которые нужно добавить в основной запрос. Это основная функция, которая возвращает результат работы всего класса. Описание параметров смотрите выше под шаблоном использования.
Возвращает: false/массив. Массив содержит JOIN и WHERE части для использования в SQL запросе. Пр: array( join => строка, where => строка )
get_sql_clauses()
(protected)
Служебный метод. Генерирует части SQL запроса. Используется в методе get_sql().
Возвращает: массив: array( join => строка, where => строка )
get_sql_for_query( & $query, $depth = 0 )
(protected)
Служебный метод. Генерирует части для отдельного SQL запроса. Если указаны вложенные запросы, этот метод рекурсивно обработает каждый из них. $query - запроса который нужно обработать. $depth - уровень вложенности на которым сейчас находимся.
Возвращает: массив: array( join => строка, where => строка )
get_sql_for_clause( & $clause, $parent_query, $clause_key = '' )
Создает SQL JOIN и WHERE части запроса для для первого условия запроса.
Возвращает: массив: array( join => строка, where => строка )
get_clauses()
Возвращает свойство $clauses.
Возвращает: массив мета частей запроса.
find_compatible_table_alias( $clause, $parent_query )
(protected)
Служебный метод. Определяет алиас таблицы относящийся к $clause.
Возвращает: строку/false
has_or_relation()
Возвращает свойство has_or_relation();
Возвращает: true/false

Код из wp-includes/class-wp-meta-query.php WP 4.7.3

<?php
class WP_Meta_Query {
	/**
	 * Array of metadata queries.
	 *
	 * See WP_Meta_Query::__construct() for information on meta query arguments.
	 *
	 * @since 3.2.0
	 * @access public
	 * @var array
	 */
	public $queries = array();

	/**
	 * The relation between the queries. Can be one of 'AND' or 'OR'.
	 *
	 * @since 3.2.0
	 * @access public
	 * @var string
	 */
	public $relation;

	/**
	 * Database table to query for the metadata.
	 *
	 * @since 4.1.0
	 * @access public
	 * @var string
	 */
	public $meta_table;

	/**
	 * Column in meta_table that represents the ID of the object the metadata belongs to.
	 *
	 * @since 4.1.0
	 * @access public
	 * @var string
	 */
	public $meta_id_column;

	/**
	 * Database table that where the metadata's objects are stored (eg $wpdb->users).
	 *
	 * @since 4.1.0
	 * @access public
	 * @var string
	 */
	public $primary_table;

	/**
	 * Column in primary_table that represents the ID of the object.
	 *
	 * @since 4.1.0
	 * @access public
	 * @var string
	 */
	public $primary_id_column;

	/**
	 * A flat list of table aliases used in JOIN clauses.
	 *
	 * @since 4.1.0
	 * @access protected
	 * @var array
	 */
	protected $table_aliases = array();

	/**
	 * A flat list of clauses, keyed by clause 'name'.
	 *
	 * @since 4.2.0
	 * @access protected
	 * @var array
	 */
	protected $clauses = array();

	/**
	 * Whether the query contains any OR relations.
	 *
	 * @since 4.3.0
	 * @access protected
	 * @var bool
	 */
	protected $has_or_relation = false;

	/**
	 * Constructor.
	 *
	 * @since 3.2.0
	 * @since 4.2.0 Introduced support for naming query clauses by associative array keys.
	 *
	 * @access public
	 *
	 * @param array $meta_query {
	 *     Array of meta query clauses. When first-order clauses or sub-clauses use strings as
	 *     their array keys, they may be referenced in the 'orderby' parameter of the parent query.
	 *
	 *     @type string $relation Optional. The MySQL keyword used to join
	 *                            the clauses of the query. Accepts 'AND', or 'OR'. Default 'AND'.
	 *     @type array {
	 *         Optional. An array of first-order clause parameters, or another fully-formed meta query.
	 *
	 *         @type string $key     Meta key to filter by.
	 *         @type string $value   Meta value to filter by.
	 *         @type string $compare MySQL operator used for comparing the $value. Accepts '=',
	 *                               '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE',
	 *                               'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'REGEXP',
	 *                               'NOT REGEXP', 'RLIKE', 'EXISTS' or 'NOT EXISTS'.
	 *                               Default is 'IN' when `$value` is an array, '=' otherwise.
	 *         @type string $type    MySQL data type that the meta_value column will be CAST to for
	 *                               comparisons. Accepts 'NUMERIC', 'BINARY', 'CHAR', 'DATE',
	 *                               'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', or 'UNSIGNED'.
	 *                               Default is 'CHAR'.
	 *     }
	 * }
	 */
	public function __construct( $meta_query = false ) {
		if ( !$meta_query )
			return;

		if ( isset( $meta_query['relation'] ) && strtoupper( $meta_query['relation'] ) == 'OR' ) {
			$this->relation = 'OR';
		} else {
			$this->relation = 'AND';
		}

		$this->queries = $this->sanitize_query( $meta_query );
	}

	/**
	 * Ensure the 'meta_query' argument passed to the class constructor is well-formed.
	 *
	 * Eliminates empty items and ensures that a 'relation' is set.
	 *
	 * @since 4.1.0
	 * @access public
	 *
	 * @param array $queries Array of query clauses.
	 * @return array Sanitized array of query clauses.
	 */
	public function sanitize_query( $queries ) {
		$clean_queries = array();

		if ( ! is_array( $queries ) ) {
			return $clean_queries;
		}

		foreach ( $queries as $key => $query ) {
			if ( 'relation' === $key ) {
				$relation = $query;

			} elseif ( ! is_array( $query ) ) {
				continue;

			// First-order clause.
			} elseif ( $this->is_first_order_clause( $query ) ) {
				if ( isset( $query['value'] ) && array() === $query['value'] ) {
					unset( $query['value'] );
				}

				$clean_queries[ $key ] = $query;

			// Otherwise, it's a nested query, so we recurse.
			} else {
				$cleaned_query = $this->sanitize_query( $query );

				if ( ! empty( $cleaned_query ) ) {
					$clean_queries[ $key ] = $cleaned_query;
				}
			}
		}

		if ( empty( $clean_queries ) ) {
			return $clean_queries;
		}

		// Sanitize the 'relation' key provided in the query.
		if ( isset( $relation ) && 'OR' === strtoupper( $relation ) ) {
			$clean_queries['relation'] = 'OR';
			$this->has_or_relation = true;

		/*
		 * If there is only a single clause, call the relation 'OR'.
		 * This value will not actually be used to join clauses, but it
		 * simplifies the logic around combining key-only queries.
		 */
		} elseif ( 1 === count( $clean_queries ) ) {
			$clean_queries['relation'] = 'OR';

		// Default to AND.
		} else {
			$clean_queries['relation'] = 'AND';
		}

		return $clean_queries;
	}

	/**
	 * Determine whether a query clause is first-order.
	 *
	 * A first-order meta query clause is one that has either a 'key' or
	 * a 'value' array key.
	 *
	 * @since 4.1.0
	 * @access protected
	 *
	 * @param array $query Meta query arguments.
	 * @return bool Whether the query clause is a first-order clause.
	 */
	protected function is_first_order_clause( $query ) {
		return isset( $query['key'] ) || isset( $query['value'] );
	}

	/**
	 * Constructs a meta query based on 'meta_*' query vars
	 *
	 * @since 3.2.0
	 * @access public
	 *
	 * @param array $qv The query variables
	 */
	public function parse_query_vars( $qv ) {
		$meta_query = array();

		/*
		 * For orderby=meta_value to work correctly, simple query needs to be
		 * first (so that its table join is against an unaliased meta table) and
		 * needs to be its own clause (so it doesn't interfere with the logic of
		 * the rest of the meta_query).
		 */
		$primary_meta_query = array();
		foreach ( array( 'key', 'compare', 'type' ) as $key ) {
			if ( ! empty( $qv[ "meta_$key" ] ) ) {
				$primary_meta_query[ $key ] = $qv[ "meta_$key" ];
			}
		}

		// WP_Query sets 'meta_value' = '' by default.
		if ( isset( $qv['meta_value'] ) && '' !== $qv['meta_value'] && ( ! is_array( $qv['meta_value'] ) || $qv['meta_value'] ) ) {
			$primary_meta_query['value'] = $qv['meta_value'];
		}

		$existing_meta_query = isset( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ? $qv['meta_query'] : array();

		if ( ! empty( $primary_meta_query ) && ! empty( $existing_meta_query ) ) {
			$meta_query = array(
				'relation' => 'AND',
				$primary_meta_query,
				$existing_meta_query,
			);
		} elseif ( ! empty( $primary_meta_query ) ) {
			$meta_query = array(
				$primary_meta_query,
			);
		} elseif ( ! empty( $existing_meta_query ) ) {
			$meta_query = $existing_meta_query;
		}

		$this->__construct( $meta_query );
	}

	/**
	 * Return the appropriate alias for the given meta type if applicable.
	 *
	 * @since 3.7.0
	 * @access public
	 *
	 * @param string $type MySQL type to cast meta_value.
	 * @return string MySQL type.
	 */
	public function get_cast_for_type( $type = '' ) {
		if ( empty( $type ) )
			return 'CHAR';

		$meta_type = strtoupper( $type );

		if ( ! preg_match( '/^(?:BINARY|CHAR|DATE|DATETIME|SIGNED|UNSIGNED|TIME|NUMERIC(?:\(\d+(?:,\s?\d+)?\))?|DECIMAL(?:\(\d+(?:,\s?\d+)?\))?)$/', $meta_type ) )
			return 'CHAR';

		if ( 'NUMERIC' == $meta_type )
			$meta_type = 'SIGNED';

		return $meta_type;
	}

	/**
	 * Generates SQL clauses to be appended to a main query.
	 *
	 * @since 3.2.0
	 * @access public
	 *
	 * @param string $type              Type of meta, eg 'user', 'post'.
	 * @param string $primary_table     Database table where the object being filtered is stored (eg wp_users).
	 * @param string $primary_id_column ID column for the filtered object in $primary_table.
	 * @param object $context           Optional. The main query object.
	 * @return false|array {
	 *     Array containing JOIN and WHERE SQL clauses to append to the main query.
	 *
	 *     @type string $join  SQL fragment to append to the main JOIN clause.
	 *     @type string $where SQL fragment to append to the main WHERE clause.
	 * }
	 */
	public function get_sql( $type, $primary_table, $primary_id_column, $context = null ) {
		if ( ! $meta_table = _get_meta_table( $type ) ) {
			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 ( false !== strpos( $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 array  $clauses           Array containing the query's JOIN and WHERE clauses.
		 * @param array  $queries           Array of meta queries.
		 * @param string $type              Type of meta.
		 * @param string $primary_table     Primary table.
		 * @param string $primary_id_column Primary column ID.
		 * @param object $context           The main query object.
		 */
		return apply_filters_ref_array( 'get_meta_sql', array( $sql, $this->queries, $type, $primary_table, $primary_id_column, $context ) );
	}

	/**
	 * Generate SQL clauses to be appended to a main query.
	 *
	 * Called by the public WP_Meta_Query::get_sql(), this method is abstracted
	 * out to maintain parity with the other Query classes.
	 *
	 * @since 4.1.0
	 * @access protected
	 *
	 * @return array {
	 *     Array containing JOIN and WHERE SQL clauses to append to the main query.
	 *
	 *     @type string $join  SQL fragment to append to the main JOIN clause.
	 *     @type string $where SQL fragment to append to the main WHERE clause.
	 * }
	 */
	protected function get_sql_clauses() {
		/*
		 * $queries are passed by reference to get_sql_for_query() for recursion.
		 * To keep $this->queries unaltered, pass a copy.
		 */
		$queries = $this->queries;
		$sql = $this->get_sql_for_query( $queries );

		if ( ! empty( $sql['where'] ) ) {
			$sql['where'] = ' AND ' . $sql['where'];
		}

		return $sql;
	}

	/**
	 * Generate SQL clauses for a single query array.
	 *
	 * If nested subqueries are found, this method recurses the tree to
	 * produce the properly nested SQL.
	 *
	 * @since 4.1.0
	 * @access protected
	 *
	 * @param array $query Query to parse, passed by reference.
	 * @param int   $depth Optional. Number of tree levels deep we currently are.
	 *                     Used to calculate indentation. Default 0.
	 * @return array {
	 *     Array containing JOIN and WHERE SQL clauses to append to a single query array.
	 *
	 *     @type string $join  SQL fragment to append to the main JOIN clause.
	 *     @type string $where SQL fragment to append to the main WHERE clause.
	 * }
	 */
	protected function get_sql_for_query( &$query, $depth = 0 ) {
		$sql_chunks = array(
			'join'  => array(),
			'where' => array(),
		);

		$sql = array(
			'join'  => '',
			'where' => '',
		);

		$indent = '';
		for ( $i = 0; $i < $depth; $i++ ) {
			$indent .= "  ";
		}

		foreach ( $query as $key => &$clause ) {
			if ( 'relation' === $key ) {
				$relation = $query['relation'];
			} elseif ( is_array( $clause ) ) {

				// This is a first-order clause.
				if ( $this->is_first_order_clause( $clause ) ) {
					$clause_sql = $this->get_sql_for_clause( $clause, $query, $key );

					$where_count = count( $clause_sql['where'] );
					if ( ! $where_count ) {
						$sql_chunks['where'][] = '';
					} elseif ( 1 === $where_count ) {
						$sql_chunks['where'][] = $clause_sql['where'][0];
					} else {
						$sql_chunks['where'][] = '( ' . implode( ' AND ', $clause_sql['where'] ) . ' )';
					}

					$sql_chunks['join'] = array_merge( $sql_chunks['join'], $clause_sql['join'] );
				// This is a subquery, so we recurse.
				} else {
					$clause_sql = $this->get_sql_for_query( $clause, $depth + 1 );

					$sql_chunks['where'][] = $clause_sql['where'];
					$sql_chunks['join'][]  = $clause_sql['join'];
				}
			}
		}

		// Filter to remove empties.
		$sql_chunks['join']  = array_filter( $sql_chunks['join'] );
		$sql_chunks['where'] = array_filter( $sql_chunks['where'] );

		if ( empty( $relation ) ) {
			$relation = 'AND';
		}

		// Filter duplicate JOIN clauses and combine into a single string.
		if ( ! empty( $sql_chunks['join'] ) ) {
			$sql['join'] = implode( ' ', array_unique( $sql_chunks['join'] ) );
		}

		// Generate a single WHERE clause with proper brackets and indentation.
		if ( ! empty( $sql_chunks['where'] ) ) {
			$sql['where'] = '( ' . "\n  " . $indent . implode( ' ' . "\n  " . $indent . $relation . ' ' . "\n  " . $indent, $sql_chunks['where'] ) . "\n" . $indent . ')';
		}

		return $sql;
	}

	/**
	 * Generate SQL JOIN and WHERE clauses for a first-order query clause.
	 *
	 * "First-order" means that it's an array with a 'key' or 'value'.
	 *
	 * @since 4.1.0
	 * @access public
	 *
	 * @global wpdb $wpdb WordPress database abstraction object.
	 *
	 * @param array  $clause       Query clause, passed by reference.
	 * @param array  $parent_query Parent query array.
	 * @param string $clause_key   Optional. The array key used to name the clause in the original `$meta_query`
	 *                             parameters. If not provided, a key will be generated automatically.
	 * @return array {
	 *     Array containing JOIN and WHERE SQL clauses to append to a first-order query.
	 *
	 *     @type string $join  SQL fragment to append to the main JOIN clause.
	 *     @type string $where SQL fragment to append to the main WHERE clause.
	 * }
	 */
	public function get_sql_for_clause( &$clause, $parent_query, $clause_key = '' ) {
		global $wpdb;

		$sql_chunks = array(
			'where' => array(),
			'join' => array(),
		);

		if ( isset( $clause['compare'] ) ) {
			$clause['compare'] = strtoupper( $clause['compare'] );
		} else {
			$clause['compare'] = isset( $clause['value'] ) && is_array( $clause['value'] ) ? 'IN' : '=';
		}

		if ( ! in_array( $clause['compare'], array(
			'=', '!=', '>', '>=', '<', '<=',
			'LIKE', 'NOT LIKE',
			'IN', 'NOT IN',
			'BETWEEN', 'NOT BETWEEN',
			'EXISTS', 'NOT EXISTS',
			'REGEXP', 'NOT REGEXP', 'RLIKE'
		) ) ) {
			$clause['compare'] = '=';
		}

		$meta_compare = $clause['compare'];

		// First build the JOIN clause, if one is required.
		$join = '';

		// We prefer to avoid joins if possible. Look for an existing join compatible with this clause.
		$alias = $this->find_compatible_table_alias( $clause, $parent_query );
		if ( false === $alias ) {
			$i = count( $this->table_aliases );
			$alias = $i ? 'mt' . $i : $this->meta_table;

			// JOIN clauses for NOT EXISTS have their own syntax.
			if ( 'NOT EXISTS' === $meta_compare ) {
				$join .= " LEFT JOIN $this->meta_table";
				$join .= $i ? " AS $alias" : '';
				$join .= $wpdb->prepare( " ON ($this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column AND $alias.meta_key = %s )", $clause['key'] );

			// All other JOIN clauses.
			} else {
				$join .= " INNER JOIN $this->meta_table";
				$join .= $i ? " AS $alias" : '';
				$join .= " ON ( $this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column )";
			}

			$this->table_aliases[] = $alias;
			$sql_chunks['join'][] = $join;
		}

		// Save the alias to this clause, for future siblings to find.
		$clause['alias'] = $alias;

		// Determine the data type.
		$_meta_type = isset( $clause['type'] ) ? $clause['type'] : '';
		$meta_type  = $this->get_cast_for_type( $_meta_type );
		$clause['cast'] = $meta_type;

		// Fallback for clause keys is the table alias. Key must be a string.
		if ( is_int( $clause_key ) || ! $clause_key ) {
			$clause_key = $clause['alias'];
		}

		// Ensure unique clause keys, so none are overwritten.
		$iterator = 1;
		$clause_key_base = $clause_key;
		while ( isset( $this->clauses[ $clause_key ] ) ) {
			$clause_key = $clause_key_base . '-' . $iterator;
			$iterator++;
		}

		// Store the clause in our flat array.
		$this->clauses[ $clause_key ] =& $clause;

		// Next, build the WHERE clause.

		// meta_key.
		if ( array_key_exists( 'key', $clause ) ) {
			if ( 'NOT EXISTS' === $meta_compare ) {
				$sql_chunks['where'][] = $alias . '.' . $this->meta_id_column . ' IS NULL';
			} else {
				$sql_chunks['where'][] = $wpdb->prepare( "$alias.meta_key = %s", trim( $clause['key'] ) );
			}
		}

		// meta_value.
		if ( array_key_exists( 'value', $clause ) ) {
			$meta_value = $clause['value'];

			if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
				if ( ! is_array( $meta_value ) ) {
					$meta_value = preg_split( '/[,\s]+/', $meta_value );
				}
			} else {
				$meta_value = trim( $meta_value );
			}

			switch ( $meta_compare ) {
				case 'IN' :
				case 'NOT IN' :
					$meta_compare_string = '(' . substr( str_repeat( ',%s', count( $meta_value ) ), 1 ) . ')';
					$where = $wpdb->prepare( $meta_compare_string, $meta_value );
					break;

				case 'BETWEEN' :
				case 'NOT BETWEEN' :
					$meta_value = array_slice( $meta_value, 0, 2 );
					$where = $wpdb->prepare( '%s AND %s', $meta_value );
					break;

				case 'LIKE' :
				case 'NOT LIKE' :
					$meta_value = '%' . $wpdb->esc_like( $meta_value ) . '%';
					$where = $wpdb->prepare( '%s', $meta_value );
					break;

				// EXISTS with a value is interpreted as '='.
				case 'EXISTS' :
					$meta_compare = '=';
					$where = $wpdb->prepare( '%s', $meta_value );
					break;

				// 'value' is ignored for NOT EXISTS.
				case 'NOT EXISTS' :
					$where = '';
					break;

				default :
					$where = $wpdb->prepare( '%s', $meta_value );
					break;

			}

			if ( $where ) {
				if ( 'CHAR' === $meta_type ) {
					$sql_chunks['where'][] = "$alias.meta_value {$meta_compare} {$where}";
				} else {
					$sql_chunks['where'][] = "CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$where}";
				}
			}
		}

		/*
		 * Multiple WHERE clauses (for meta_key and meta_value) should
		 * be joined in parentheses.
		 */
		if ( 1 < count( $sql_chunks['where'] ) ) {
			$sql_chunks['where'] = array( '( ' . implode( ' AND ', $sql_chunks['where'] ) . ' )' );
		}

		return $sql_chunks;
	}

	/**
	 * Get a flattened list of sanitized meta clauses.
	 *
	 * This array should be used for clause lookup, as when the table alias and CAST type must be determined for
	 * a value of 'orderby' corresponding to a meta clause.
	 *
	 * @since 4.2.0
	 * @access public
	 *
	 * @return array Meta clauses.
	 */
	public function get_clauses() {
		return $this->clauses;
	}

	/**
	 * Identify an existing table alias that is compatible with the current
	 * query clause.
	 *
	 * We avoid unnecessary table joins by allowing each clause to look for
	 * an existing table alias that is compatible with the query that it
	 * needs to perform.
	 *
	 * An existing alias is compatible if (a) it is a sibling of `$clause`
	 * (ie, it's under the scope of the same relation), and (b) the combination
	 * of operator and relation between the clauses allows for a shared table join.
	 * In the case of WP_Meta_Query, this only applies to 'IN' clauses that are
	 * connected by the relation 'OR'.
	 *
	 * @since 4.1.0
	 * @access protected
	 *
	 * @param  array       $clause       Query clause.
	 * @param  array       $parent_query Parent query of $clause.
	 * @return string|bool Table alias if found, otherwise false.
	 */
	protected function find_compatible_table_alias( $clause, $parent_query ) {
		$alias = false;

		foreach ( $parent_query as $sibling ) {
			// If the sibling has no alias yet, there's nothing to check.
			if ( empty( $sibling['alias'] ) ) {
				continue;
			}

			// We're only interested in siblings that are first-order clauses.
			if ( ! is_array( $sibling ) || ! $this->is_first_order_clause( $sibling ) ) {
				continue;
			}

			$compatible_compares = array();

			// Clauses connected by OR can share joins as long as they have "positive" operators.
			if ( 'OR' === $parent_query['relation'] ) {
				$compatible_compares = array( '=', 'IN', 'BETWEEN', 'LIKE', 'REGEXP', 'RLIKE', '>', '>=', '<', '<=' );

			// Clauses joined by AND with "negative" operators share a join only if they also share a key.
			} elseif ( isset( $sibling['key'] ) && isset( $clause['key'] ) && $sibling['key'] === $clause['key'] ) {
				$compatible_compares = array( '!=', 'NOT IN', 'NOT LIKE' );
			}

			$clause_compare  = strtoupper( $clause['compare'] );
			$sibling_compare = strtoupper( $sibling['compare'] );
			if ( in_array( $clause_compare, $compatible_compares ) && in_array( $sibling_compare, $compatible_compares ) ) {
				$alias = $sibling['alias'];
				break;
			}
		}

		/**
		 * Filters the table alias identified as compatible with the current clause.
		 *
		 * @since 4.1.0
		 *
		 * @param string|bool $alias        Table alias, or false if none was found.
		 * @param array       $clause       First-order query clause.
		 * @param array       $parent_query Parent of $clause.
		 * @param object      $this         WP_Meta_Query object.
		 */
		return apply_filters( 'meta_query_find_compatible_table_alias', $alias, $clause, $parent_query, $this ) ;
	}

	/**
	 * Checks whether the current query has any OR relations.
	 *
	 * In some cases, the presence of an OR relation somewhere in the query will require
	 * the use of a `DISTINCT` or `GROUP BY` keyword in the `SELECT` clause. The current
	 * method can be used in these cases to determine whether such a clause is necessary.
	 *
	 * @since 4.3.0
	 *
	 * @return bool True if the query contains any `OR` relations, otherwise false.
	 */
	public function has_or_relation() {
		return $this->has_or_relation;
	}
}

Связанные Функции

Из раздела: Классы

WP_Meta_Query 4 комментария
  • campusboy1381 cайт: wp-plus.ru
    @

    В 4 примере идёт отсылка на метазапросы в wp_query (ссылка), вот в ней хеш неверный и переходе по ссылке ничего не происходит. Правильный хеш #parametry-proizvolnyh-polej-postmeta.

    1
  • Tim

    Добрый день Кама,
    если в meta_value хранится значения чекбоксов в сериализованной строке, например так:

    a:2:{s:64:"wpcf-fields-checkboxes-option-2d0b0a0d5e032de4e27772156576f2d3-1";a:1:{i:0;s:17:"Simplified Pumba";}s:64:"wpcf-fields-checkboxes-option-469259717b39d3ce863f468291999b78-1";a:1:{i:0;s:18:"Traditional Pumba";}}

    как правильно задать параметр ? Вот так :

        'meta_query' => array(
    	  array(
    		'key' => 'wpcf-reader-character',
    		'value' => 'Simplified Pumba'
    	  ),

    не находит значение.

    Ответить3 месяца назад #
    • Kama4192

      Надо делать поиск по значению...

          'meta_query' => array(
      	  array(
      		'key' => 'wpcf-reader-character',
      		'value' => '%Simplified Pumba%',
      		'compare' => 'LIKE',
      	  ),

      Но это тяжелый запрос, имей ввиду!

      Ответить3 месяца назад #

Здравствуйте, !

Ваш комментарий