WP_Meta_Query

Методы

find_compatible_table_alias()

Метод find_compatible_table_alias() класса WP_Meta_Query идентифицирует существующий псевдоним таблицы, совместимый с текущим запросом.

Этот метод используется для поиска псевдонима таблицы, который может быть использован в запросе для связи с таблицей метаданных.

WP_Meta_Query::find_compatible_table_alias( array $clause, array $parent_query ): string|false

Метод find_compatible_table_alias() принимает два обязательных параметра: $clause (массив) и $parent_query (массив).

$clause: Запросовый клауз. Это массив, содержащий информацию о метаданных, которые необходимо найти.

$parent_query: Родительский запрос. Это массив, содержащий информацию о родительском запросе, в котором выполняется поиск метаданных.

Метод find_compatible_table_alias() возвращает псевдоним таблицы, если он найден, в противном случае возвращает false.

<code>// Пример использования метода find_compatible_table_alias()
$clause = array(
    'key'     => 'color',
    'value'   => 'blue',
    'compare' => 'LIKE'
);
$parent_query = array(
    'relation' => 'AND',
    array(
        'key'     => 'size',
        'value'   => 'large',
        'compare' => '='
    ),
    array(
        'key'     => 'price',
        'value'   => 100,
        'compare' => '>'
    )
);
$table_alias = WP_Meta_Query::find_compatible_table_alias( $clause, $parent_query );
if ( $table_alias ) {
    echo 'Compatible table alias found: ' . $table_alias;
} else {
    echo 'No compatible table alias found.';
}

get_cast_for_type()

Метод get_cast_for_type() класса WP_Meta_Query возвращает подходящий псевдоним для указанного типа метаданных, если это применимо. Он используется для приведения значения метаданных к определенному типу данных в MySQL.

WP_Meta_Query::get_cast_for_type( string $type = '' ): string

Метод get_cast_for_type() принимает один необязательный параметр:

• $type (строка) — Опциональный тип данных MySQL для приведения значения метаданных. По умолчанию: пустая строка.

• $type (строка) — Опциональный тип данных MySQL для приведения значения метаданных. По умолчанию: пустая строка.

Параметр $type определяет тип данных MySQL, к которому будет приведено значение метаданных. Если не указан, метод вернет пустую строку.

Метод get_cast_for_type() возвращает строку, представляющую тип данных MySQL.

$type = 'NUMERIC'; // Тип данных MySQL
$cast = WP_Meta_Query::get_cast_for_type( $type ); // Получение псевдонима для указанного типа данных
echo $cast; // Выводит 'SIGNED'

В данном примере мы указываем тип данных MySQL как ‘NUMERIC’ и вызываем метод get_cast_for_type() для получения соответствующего псевдонима. Затем мы выводим полученный псевдоним, который будет равен ‘SIGNED’.

get_clauses()

Метод get_clauses() класса WP_Meta_Query используется для получения списка санитарных мета-условий. Он возвращает сплющенный (flattened) список мета-условий, которые были санитизированы.

Метод get_clauses() позволяет получить список мета-условий, которые были добавлены в запрос мета-данных. Этот метод используется внутри класса WP_Meta_Query для формирования SQL-запроса к базе данных.

WP_Meta_Query::get_clauses(): array

Метод get_clauses() вызывается статически, без создания экземпляра класса WP_Meta_Query. Он возвращает массив, содержащий список санитарных мета-условий.

Код:

/**
 * Get the meta clauses.
 *
 * @since 3.2.0
 *
 * @return array Meta clauses.
 */
public static function get_clauses() {
    return self::$clauses;
}

В данном коде метод get_clauses() определен как публичный и статический. Он возвращает значение свойства $clauses класса WP_Meta_Query, которое представляет собой массив мета-условий.

Метод get_clauses() возвращает массив мета-условий, который был санитизирован и сплющен.

get_sql()

Метод get_sql() класса WP_Meta_Query генерирует SQL-запросы, которые будут добавлены к основному запросу.

Этот метод используется для создания и добавления дополнительных условий к основному запросу на основе метаданных.

WP_Meta_Query::get_sql( string $type, string $primary_table, string $primary_id_column, object $context = null ): string[]|false

Метод get_sql() принимает следующие параметры:

• $type (обязательный) — Тип метаданных. Возможные значения включают, но не ограничиваются ‘post’, ‘comment’, ‘blog’, ‘term’ и ‘user’.
• $primary_table (обязательный) — Имя таблицы базы данных, где хранится фильтруемый объект (например, wp_users).
• $primary_id_column (обязательный) — Колонка ID для фильтруемого объекта в таблице $primary_table.
• $context (необязательный) — Объект основного запроса, соответствующий типу, например, WP_Query, WP_User_Query или WP_Site_Query. По умолчанию: null.

Метод get_sql() возвращает массив, содержащий SQL-запросы JOIN и WHERE, которые будут добавлены к основному запросу. Если для запрошенного типа метаданных не существует таблицы, метод вернет false.

/**
 * Пример использования метода get_sql()
 */
$type = 'post';
$primary_table = 'wp_posts';
$primary_id_column = 'ID';
$context = null;
$query = WP_Meta_Query::get_sql( $type, $primary_table, $primary_id_column, $context );
// Выводим результаты
echo 'JOIN: ' . $query['join'] . '<br>';
echo 'WHERE: ' . $query['where'];

В приведенном выше примере мы используем метод get_sql() для генерации SQL-запросов для типа метаданных «post». Мы передаем имя таблицы wp_posts, колонку ID ID и объект основного запроса null. Затем мы выводим результаты, включая JOIN и WHERE SQL-запросы.

get_sql_clauses()

Метод get_sql_clauses() является частью класса WP_Meta_Query, который используется для реализации мета-запросов для Meta API в WordPress. Он генерирует SQL-клаузы, которые должны быть добавлены к основному запросу.

Этот метод работает путем анализа аргументов мета-запроса и генерации соответствующих SQL-клауз. Он определяет, какие таблицы и столбцы должны быть присоединены к основному запросу, а также какие условия WHERE должны быть добавлены для фильтрации результатов.

Метод get_sql_clauses() используется внутри основного запроса WordPress для обработки мета-запросов и включения соответствующих данных мета в результаты запроса.

WP_Meta_Query::get_sql_clauses()

Этот код вызывает метод get_sql_clauses() класса WP_Meta_Query.

Комментарии к коду:

• Метод get_sql_clauses() не принимает аргументов.

Метод get_sql_clauses() возвращает массив строк, содержащий SQL-клаузы JOIN и WHERE, которые должны быть добавлены к основному запросу.

Комментарии к коду:

• Массив строк содержит SQL-клаузы, которые определяют, какие таблицы и столбцы должны быть присоединены к основному запросу, а также какие условия WHERE должны быть добавлены для фильтрации результатов.

get_sql_for_clause()

Метод get_sql_for_clause() генерирует SQL JOIN и WHERE выражения для запроса первого порядка. Он используется для реализации мета-запросов в Meta API.

WP_Meta_Query::get_sql_for_clause( array $clause, array $parent_query, string $clause_key = '' ): array

Метод get_sql_for_clause() принимает три параметра:

• $clause (обязательный) — Запрос (передается по ссылке).
• $parent_query (обязательный) — Родительский массив запроса.
• $clause_key (необязательный) — Ключ массива, используемый для именования запроса в исходных параметрах $meta_query. Если не указан, ключ будет сгенерирован автоматически. По умолчанию: ».

Метод get_sql_for_clause() возвращает массив, содержащий SQL JOIN и WHERE выражения для добавления к запросу первого порядка.

<?php
$clause = array(
  'key'     => 'color',
  'value'   => 'blue',
  'compare' => 'LIKE',
);
$parent_query = array(
  'relation' => 'AND',
  array(
    'key'     => 'size',
    'value'   => 'large',
    'compare' => '=',
  ),
  array(
    'key'     => 'price',
    'value'   => 100,
    'compare' => '>',
    'type'    => 'NUMERIC',
  ),
);
$clause_key = 'meta_query';
$result = WP_Meta_Query::get_sql_for_clause( $clause, $parent_query, $clause_key );
print_r( $result );
?>

В приведенном выше примере кода мы создаем запрос мета-запроса с помощью массивов $clause и $parent_query. Затем мы вызываем метод get_sql_for_clause() с этими параметрами и сохраняем результат в переменную $result. Наконец, мы выводим результат с помощью функции print_r().

get_sql_for_query()

Метод get_sql_for_query() класса WP_Meta_Query используется для генерации SQL-запросов для одного массива запросов.

Он принимает массив запросов и глубину в качестве параметров и возвращает массив строк SQL для объединения и условий WHERE, которые нужно добавить к одному массиву запросов.

WP_Meta_Query::get_sql_for_query( array $query, int $depth ): string[]

Метод get_sql_for_query() принимает два параметра: массив запросов $query (обязательный) и глубину $depth (необязательный).

$query (array) — Обязательный. Запрос для разбора (передается по ссылке).

$depth (int) — Необязательный. Количество уровней дерева, на котором мы находимся. Используется для вычисления отступа. По умолчанию 0.

Метод get_sql_for_query() возвращает массив строк SQL, содержащих объединения и условия WHERE, которые нужно добавить к одному массиву запросов.

<?php
$query = array(
    'relation' => 'AND',
    array(
        'key'     => 'color',
        'value'   => 'blue',
        'compare' => 'LIKE'
    ),
    array(
        'relation' => 'OR',
        array(
            'key'     => 'size',
            'value'   => 'small',
            'compare' => 'LIKE'
        ),
        array(
            'key'     => 'size',
            'value'   => 'medium',
            'compare' => 'LIKE'
        )
    )
);
$depth = 0;
$result = WP_Meta_Query::get_sql_for_query( $query, $depth );
?>

В приведенном выше примере мы создаем массив запросов $query, который содержит условия для поиска элементов с определенными значениями ключей метаданных. Затем мы устанавливаем глубину $depth в 0. Затем мы вызываем метод get_sql_for_query() класса WP_Meta_Query с этими параметрами и сохраняем результат в переменную $result.

has_or_relation()

Метод has_or_relation() класса WP_Meta_Query используется для проверки, содержит ли текущий запрос какие-либо OR-отношения.

OR-отношения используются в мета-запросах для объединения нескольких условий с использованием оператора «ИЛИ». Если текущий запрос содержит хотя бы одно OR-отношение, метод has_or_relation() вернет значение true, в противном случае — false.

WP_Meta_Query::has_or_relation(): bool

Метод has_or_relation() не принимает никаких аргументов.

Пример использования:

// Создаем новый объект мета-запроса
$meta_query = new WP_Meta_Query();
// Проверяем, содержит ли текущий запрос OR-отношения
$has_or_relation = $meta_query->has_or_relation();
// Выводим результат
if ($has_or_relation) {
    echo 'Текущий запрос содержит OR-отношения';
} else {
    echo 'Текущий запрос не содержит OR-отношений';
}

В данном примере мы создаем новый объект мета-запроса и затем проверяем, содержит ли текущий запрос OR-отношения с помощью метода has_or_relation(). Результат проверки выводится на экран.

Метод has_or_relation() возвращает значение типа bool. Если текущий запрос содержит хотя бы одно OR-отношение, метод вернет значение true, в противном случае — false.

is_first_order_clause()

Метод is_first_order_clause() класса WP_Meta_Query определяет, является ли запрос первичным.

Первичный запрос — это запрос, который является основным запросом для выборки данных из базы данных. Он определяет основные параметры выборки, такие как таблицы, условия, сортировка и т. д.

Метод is_first_order_clause() используется для проверки, является ли указанный запрос первичным. Он возвращает логическое значение true, если запрос является первичным, и false, если запрос не является первичным.

WP_Meta_Query::is_first_order_clause( array $query ): bool

Метод is_first_order_clause() принимает один параметр:

• $query (обязательный) — Массив аргументов мета-запроса.

Метод возвращает логическое значение true, если запрос является первичным, и false, если запрос не является первичным.

$query (обязательный) — Массив аргументов мета-запроса. Этот массив содержит параметры для определения мета-запроса, такие как ключевые слова, значения, операторы и т. д.

Метод is_first_order_clause() возвращает логическое значение true, если запрос является первичным, и false, если запрос не является первичным.

<code>$query = array(
    'key'     => 'color',
    'value'   => 'blue',
    'compare' => 'LIKE'
);
$is_first_order_clause = WP_Meta_Query::is_first_order_clause( $query );
</code>

В приведенном выше примере кода мы создаем массив $query с параметрами мета-запроса. Затем мы вызываем метод is_first_order_clause() класса WP_Meta_Query и передаем ему этот массив в качестве аргумента. Результатом будет логическое значение $is_first_order_clause, которое будет содержать true, если запрос является первичным, и false, если запрос не является первичным.

parse_query_vars()

Метод parse_query_vars() является частью класса WP_Meta_Query и используется для создания запроса к метаданным на основе переменных запроса, начинающихся с префикса ‘meta_’. Он конструирует и возвращает объект WP_Meta_Query, который может быть использован для выполнения запроса к метаданным.

WP_Meta_Query::parse_query_vars( array $qv )

Метод parse_query_vars() принимает один обязательный параметр $qv, который является массивом переменных запроса. Он анализирует этот массив и создает объект WP_Meta_Query на основе переменных запроса, начинающихся с префикса ‘meta_’.

$qv (array) (обязательный): Массив переменных запроса.

<?php
// Создание массива переменных запроса
$qv = array(
    'meta_key' => 'color',
    'meta_value' => 'blue',
    'meta_compare' => 'LIKE'
);
// Вызов метода parse_query_vars() с передачей массива переменных запроса
$meta_query = WP_Meta_Query::parse_query_vars( $qv );
// Вывод результата
var_dump( $meta_query );
?>

В приведенном выше примере мы создаем массив переменных запроса, который содержит ключ ‘meta_key’ со значением ‘color’, значение метаданных ‘blue’ и оператор сравнения ‘LIKE’. Затем мы вызываем метод parse_query_vars() и передаем ему этот массив. Метод анализирует массив и создает объект WP_Meta_Query на основе переданных переменных запроса. Результат выводится с помощью функции var_dump().

sanitize_query()

Метод sanitize_query() класса WP_Meta_Query используется для обеспечения правильной структуры аргумента meta_query, передаваемого в конструктор класса.

Метод проверяет и форматирует аргумент meta_query, чтобы убедиться, что он соответствует ожидаемому формату и не содержит ошибок.

WP_Meta_Query::sanitize_query( array $queries ): array

Метод sanitize_query() принимает один обязательный параметр — массив запросов ($queries) и возвращает отформатированный и проверенный массив запросов.

$queries (обязательный): Массив запросов. Каждый элемент массива представляет собой массив, содержащий параметры для мета-запроса. Подробное описание параметров можно найти в документации WordPress.

Метод sanitize_query() возвращает отформатированный и проверенный массив запросов.

/**
 * Пример использования метода sanitize_query()
 */
$meta_query = array(
    array(
        'key'     => 'color',
        'value'   => 'blue',
        'compare' => 'LIKE'
    ),
    array(
        'key'     => 'size',
        'value'   => 'medium',
        'compare' => 'LIKE'
    )
);
$sanitized_query = WP_Meta_Query::sanitize_query( $meta_query );
// Вывод отформатированного и проверенного массива запросов
print_r( $sanitized_query );

В приведенном выше примере мы создаем массив $meta_query с двумя элементами, представляющими запросы к мета-данным. Затем мы вызываем метод sanitize_query() и передаем ему массив $meta_query. Метод возвращает отформатированный и проверенный массив запросов, который мы выводим с помощью функции print_r().

__construct()

Метод «__construct()» является конструктором класса «WP_Meta_Query». Он вызывается при создании нового объекта класса и используется для инициализации свойств объекта.

Класс «WP_Meta_Query» является ядром для реализации мета-запросов для Meta API.

WP_Meta_Query::__construct( array $meta_query = false )

Конструктор класса «WP_Meta_Query» принимает один необязательный параметр — массив мета-запросов.

Параметр $meta_query представляет собой массив мета-запросов, который определяет условия фильтрации мета-данных. Когда первоуровневые условия или подусловия используют строки в качестве ключей массива, они могут быть использованы в параметре ‘orderby’ родительского запроса.

• $meta_query (array) — Необязательный. Массив мета-запросов. По умолчанию: false.
• relation (string) — Необязательный. Ключевое слово MySQL, используемое для объединения условий запроса. Принимает значения ‘AND’ или ‘OR’. По умолчанию: ‘AND’.
• $0 (array) — Необязательный. Массив параметров первого уровня или другой полностью сформированный мета-запрос.
• key (string|string[]) — Ключ или ключи мета-данных для фильтрации.
• compare_key (string) — Оператор MySQL, используемый для сравнения ключа. Принимает значения: ‘=’, ‘!=’, ‘LIKE’, ‘NOT LIKE’, ‘IN’, ‘NOT IN’, ‘REGEXP’, ‘NOT REGEXP’, ‘RLIKE’, ‘EXISTS’ (псевдоним ‘=’) и ‘NOT EXISTS’ (псевдоним ‘!=’). По умолчанию: ‘IN’ при использовании массива ключей, ‘=’ в остальных случаях.
• type_key (string) — Тип данных MySQL, к которому будет приведен столбец meta_key для сравнения. Принимает значение ‘BINARY’ для регистрозависимого сравнения с использованием регулярных выражений. По умолчанию: ».
• value (string|string[]) — Значение или значения мета-данных для фильтрации.
• compare (string) — Оператор MySQL, используемый для сравнения значения. Принимает значения: ‘=’, ‘!=’, ‘>’, ‘>=’, ‘<', '<='. По умолчанию: '='.

<?php
$args = array(
    'meta_query' => array(
        'relation' => 'AND',
        array(
            'key' => 'color',
            'value' => 'blue',
            'compare' => '='
        ),
        array(
            'key' => 'size',
            'value' => array( 'small', 'medium' ),
            'compare' => 'IN'
        )
    )
);
$meta_query = new WP_Meta_Query( $args );
?>

В данном примере создается объект класса «WP_Meta_Query» с использованием массива мета-запросов. В массиве определены два условия фильтрации мета-данных: по ключу ‘color’ со значением ‘blue’ и по ключу ‘size’ со значениями ‘small’ и ‘medium’.

$args = array(
    'key'     => 'color',
    'value'   => 'blue',
    'compare' => 'LIKE',
);
$meta_query = new WP_Meta_Query( $args );

$args = array(
    'meta_key' => 'color',
);
$meta_query = new WP_Meta_Query( $args );
$meta_fields = $meta_query->get_clauses();

$args = array(
    'meta_query' => array(
        array(
            'key'     => 'color',
            'value'   => 'blue',
            'compare' => 'LIKE',
        ),
        array(
            'key'     => 'size',
            'value'   => 'large',
            'compare' => 'LIKE',
        ),
    ),
);
$meta_query = new WP_Meta_Query( $args );

$args = array(
    'meta_query' => array(
        array(
            'key'     => 'color',
            'value'   => 'blue',
            'compare' => 'LIKE',
        ),
        array(
            'key'     => 'size',
            'value'   => 'large',
            'compare' => 'LIKE',
        ),
    ),
);
$meta_query = new WP_Meta_Query( $args );
$sql_clauses = $meta_query->get_sql( 'post', 'wp_posts', 'ID' );

$args = array(
    'meta_query' => array(
        array(
            'key'     => 'color',
            'value'   => array( 'red', 'blue' ),
            'compare' => 'IN',
        ),
    ),
);
$query = new WP_Query( $args );

$args = array(
    'meta_query' => array(
        array(
            'key'     => 'name',
            'value'   => 'John',
            'compare' => 'NOT LIKE',
        ),
    ),
);
$query = new WP_Query( $args );

$args = array(
    'meta_query' => array(
        array(
            'key'     => 'price',
            'value'   => array( 100, 200 ),
            'type'    => 'numeric',
            'compare' => 'BETWEEN',
        ),
    ),
);
$query = new WP_Query( $args );

$meta_query = new WP_Meta_Query();
$meta_query->set_query_vars( array(
    'meta_query' => array(
        array(
            'key'     => 'my_meta_key',
            'compare' => 'EXISTS',
        ),
    ),
) );
$sql = $meta_query->get_sql();

$meta_query = new WP_Meta_Query();
$meta_query->set_query_vars( array(
    'meta_query' => array(
        array(
            'key'     => 'my_meta_key',
            'compare' => 'NOT EXISTS',
        ),
    ),
) );
$sql = $meta_query->get_sql();

$meta_query = new WP_Meta_Query();
$meta_query->set_query_vars( array(
    'meta_query' => array(
        array(
            'key'     => 'my_meta_key',
            'value'   => '^test',
            'compare' => 'REGEXP',
        ),
    ),
) );
$sql = $meta_query->get_sql();

$meta_query = new WP_Meta_Query();
$meta_query->set_query_vars( array(
    'meta_query' => array(
        array(
            'key'     => 'my_meta_key',
            'value'   => 'test',
            'compare' => 'LIKE',
        ),
    ),
) );
$sql = $meta_query->get_sql();