WP_Tax_Query

Методы

clean_query()

Метод clean_query() является частью класса WP_Tax_Query, который используется для реализации запросов к таксономиям в Taxonomy API. Он предназначен для валидации отдельного запроса.

Метод clean_query() проверяет переданный запрос на корректность и возвращает его, если он прошел проверку. Если запрос содержит ошибки, метод возвращает пустой массив.

Этот метод используется для обработки запросов, связанных с таксономиями, и гарантирует, что запросы будут выполнены без ошибок и соответствующим образом обработаны.

WP_Tax_Query::clean_query( array $query )

Метод clean_query() принимает один обязательный параметр $query — массив с запросом. Параметр передается по ссылке.

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

// Создаем объект WP_Tax_Query
$tax_query = new WP_Tax_Query();
// Определяем запрос
$query = array(
    'taxonomy' => 'category',
    'field'    => 'slug',
    'terms'    => 'news'
);
// Вызываем метод clean_query() для валидации запроса
$clean_query = $tax_query->clean_query( $query );

В данном примере мы создаем объект WP_Tax_Query и определяем запрос к таксономии category. Затем мы вызываем метод clean_query() для валидации запроса и сохраняем результат в переменную $clean_query.

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

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

<?php
// Создаем объект WP_Tax_Query
$tax_query = new WP_Tax_Query();
// Определяем запрос
$query = array(
    'taxonomy' => 'category',
    'field'    => 'slug',
    'terms'    => 'news'
);
// Вызываем метод clean_query() для валидации запроса
$clean_query = $tax_query->clean_query( $query );
?>

В данном примере мы создаем объект WP_Tax_Query и определяем запрос к таксономии category. Затем мы вызываем метод clean_query() для валидации запроса и сохраняем результат в переменную $clean_query.

find_compatible_table_alias()

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

Метод работает следующим образом:

• Принимает два обязательных параметра: $clause — запросовая фраза и $parent_query — родительский запрос для $clause.
• Проверяет, существует ли уже псевдоним таблицы, который совместим с текущим запросом.
• Если совместимый псевдоним таблицы найден, возвращает его.
• Если совместимый псевдоним таблицы не найден, возвращает false.

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

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

• $clause (array) — Обязательный. Запросовая фраза.
• $parent_query (array) — Обязательный. Родительский запрос для $clause.

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

<?php
/**
 * Пример использования метода find_compatible_table_alias()
 *
 * @param array $clause       Запросовая фраза.
 * @param array $parent_query Родительский запрос для $clause.
 *
 * @return string|false       Псевдоним таблицы, если найден, в противном случае - false.
 */
$alias = WP_Tax_Query::find_compatible_table_alias( $clause, $parent_query );
?>

get_sql()

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

WP_Tax_Query::get_sql( string $primary_table, string $primary_id_column ): string[]

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

• $primary_table (строка) — Имя таблицы базы данных, в которой хранится объект, по которому выполняется фильтрация (например, wp_users).
• $primary_id_column (строка) — Имя столбца ID для фильтруемого объекта в таблице $primary_table.

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

/**
 * Пример использования метода get_sql()
 *
 * @param string $primary_table      Имя таблицы базы данных.
 * @param string $primary_id_column  Имя столбца ID.
 * @return string[]                  Массив строк с SQL-клаузами.
 */
function example_get_tax_query_sql( $primary_table, $primary_id_column ) {
    // Создаем экземпляр класса WP_Tax_Query
    $tax_query = new WP_Tax_Query();
    // Генерируем SQL-клаузы
    $sql_clauses = $tax_query->get_sql( $primary_table, $primary_id_column );
    // Возвращаем результат
    return $sql_clauses;
}

get_sql_clauses()

Метод get_sql_clauses() класса WP_Tax_Query используется для генерации SQL-запросов, которые будут добавлены к основному запросу. Он генерирует SQL-запросы для добавления соединений и условий WHERE к основному запросу.

WP_Tax_Query::get_sql_clauses(): string[]

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

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

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

get_sql_for_clause()

Метод get_sql_for_clause() генерирует SQL JOIN и WHERE выражения для «первичного» запроса.

Он используется для создания SQL запросов, связанных с таксономией, в рамках Taxonomy API.

WP_Tax_Query::get_sql_for_clause( array $clause, array $parent_query ): array

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

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

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

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

<?php
// Пример использования метода get_sql_for_clause()
// Создаем объект WP_Tax_Query
$tax_query = new WP_Tax_Query();
// Задаем параметры для запроса
$clause = array(
    'taxonomy' => 'category',
    'field' => 'slug',
    'terms' => 'news',
    'operator' => 'IN',
);
$parent_query = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'post_tag',
        'field' => 'slug',
        'terms' => 'featured',
        'operator' => 'IN',
    ),
);
// Вызываем метод get_sql_for_clause()
$result = $tax_query->get_sql_for_clause( $clause, $parent_query );
// Выводим результат
print_r( $result );
?>

В данном примере мы создаем объект WP_Tax_Query и задаем параметры для запроса. Затем вызываем метод get_sql_for_clause() с передачей параметров $clause и $parent_query. Результатом будет массив с SQL выражениями JOIN и WHERE, которые можно добавить к первичному запросу.

get_sql_for_query()

Метод get_sql_for_query() класса WP_Tax_Query генерирует SQL-запросы для одного массива запросов. Он используется для создания SQL-клауз JOIN и WHERE, которые добавляются к одному массиву запросов.

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

Этот метод принимает два параметра: массив запросов $query (обязательный) и глубину дерева $depth (необязательный). Он возвращает массив строк, содержащих SQL-клаузы JOIN и WHERE, которые нужно добавить к одному массиву запросов.

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

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

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

<?php
$query = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'category',
        'field' => 'slug',
        'terms' => array( 'term1', 'term2' ),
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'post_tag',
        'field' => 'slug',
        'terms' => array( 'tag1', 'tag2' ),
        'operator' => 'NOT IN',
    ),
);
$depth = 0;
$result = WP_Tax_Query::get_sql_for_query( $query, $depth );
// Выводим результат
print_r( $result );
?>

В данном примере мы создаем массив запросов $query, содержащий два элемента. Затем мы указываем глубину дерева $depth равной 0. Затем мы вызываем метод get_sql_for_query() класса WP_Tax_Query и передаем ему наши параметры. Результатом будет массив строк, содержащих SQL-клаузы JOIN и WHERE, которые нужно добавить к одному массиву запросов.

is_first_order_clause()

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

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

Метод проверяет, является ли заданное условие первым в массиве условий запроса.

WP_Tax_Query::is_first_order_clause( array $query ): bool

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

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

$query

Тип: массив

Обязательный: Да

Описание: Массив аргументов запроса налогов.

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

<?php
$query = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'category',
        'field'    => 'slug',
        'terms'    => 'news',
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'post_tag',
        'field'    => 'slug',
        'terms'    => 'featured',
        'operator' => 'NOT IN',
    ),
);
$is_first_order_clause = WP_Tax_Query::is_first_order_clause( $query );
if ( $is_first_order_clause ) {
    echo 'The first order clause is present in the query.';
} else {
    echo 'The first order clause is not present in the query.';
}
?>

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

sanitize_query()

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

Этот метод проверяет и форматирует аргумент tax_query, чтобы убедиться, что он содержит корректные данные и может быть использован для построения запроса к таксономиям.

WP_Tax_Query::sanitize_query( array $queries ): array

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

Возвращает отформатированный и проверенный массив запросов к таксономиям.

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

• taxonomy (обязательный): Название таксономии.
• terms (обязательный): Список терминов таксономии.
• field: Поле, по которому производится сравнение. Возможные значения: ‘term_id’, ‘name’, ‘slug’, ‘term_taxonomy_id’ (по умолчанию).
• operator: Оператор для сравнения. Возможные значения: ‘IN’, ‘NOT IN’, ‘AND’ (по умолчанию).
• include_children: Включать дочерние элементы. Возможные значения: true, false (по умолчанию).
• parent: Родительский термин.
• childless: Исключать термины без дочерних элементов. Возможные значения: true, false (по умолчанию).

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

<?php
// Пример использования метода sanitize_query()
// Массив запросов к таксономиям
$tax_queries = array(
    array(
        'taxonomy' => 'category',
        'terms'    => array( 1, 2, 3 ),
        'field'    => 'term_id',
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'post_tag',
        'terms'    => array( 'tag1', 'tag2' ),
        'field'    => 'slug',
        'operator' => 'AND',
    ),
);
// Отформатированный и проверенный массив запросов к таксономиям
$sanitized_queries = WP_Tax_Query::sanitize_query( $tax_queries );
?>

sanitize_relation()

Метод sanitize_relation() класса WP_Tax_Query используется для санитизации оператора ‘relation’ в запросе таксономии. Он принимает необработанный ключ ‘relation’ из аргумента запроса и возвращает санитизированное значение (‘AND’ или ‘OR’).

WP_Tax_Query::sanitize_relation( string $relation ): string

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

• $relation (string) — Необработанный ключ ‘relation’ из аргумента запроса.

$relation (string) — Обязательный. Необработанный ключ ‘relation’ из аргумента запроса.

string — Санитизированное значение ‘relation’ (‘AND’ или ‘OR’).

/**
 * Пример использования метода sanitize_relation()
 */
$relation = 'AND';
// Санитизация оператора 'relation'
$sanitized_relation = WP_Tax_Query::sanitize_relation( $relation );
// Вывод санитизированного значения
echo $sanitized_relation;

В данном примере мы сначала устанавливаем значение переменной $relation равным ‘AND’. Затем мы вызываем метод sanitize_relation() класса WP_Tax_Query и передаем в него значение переменной $relation. Метод санитизирует значение и возвращает санитизированное значение ‘AND’. Затем мы выводим санитизированное значение с помощью функции echo.

transform_query()

Метод transform_query() класса WP_Tax_Query используется для преобразования одного поля запроса в другое. Он принимает один аргумент — массив запроса, и возвращает преобразованный массив с указанным результатом.

Данный метод используется внутри класса WP_Tax_Query для преобразования запросов налогономией. Он позволяет изменить поле запроса, которое будет использоваться для сравнения с указанным значением.

WP_Tax_Query::transform_query( array $query, string $resulting_field )

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

• $query (обязательный) — одиночный запрос. Передается по ссылке.
• $resulting_field (обязательный) — результирующее поле. Принимает значения ‘slug’, ‘name’, ‘term_taxonomy_id’ или ‘term_id’. По умолчанию установлено значение ‘term_id’.

$query = array(
  'taxonomy' => 'category',
  'field' => 'slug',
  'terms' => 'news'
);
$resulting_field = 'term_id';
WP_Tax_Query::transform_query( $query, $resulting_field );

В данном примере мы имеем запрос налогономии, который ищет записи из таксономии ‘category’ по полю ‘slug’ и значению ‘news’. Мы хотим преобразовать запрос так, чтобы он использовал поле ‘term_id’ для сравнения. Метод transform_query() принимает этот запрос и преобразует его, возвращая массив с измененным полем запроса.

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

$resulting_field (обязательный) — Результирующее поле. Принимает значения ‘slug’, ‘name’, ‘term_taxonomy_id’ или ‘term_id’. По умолчанию установлено значение ‘term_id’.

__construct()

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

Конструктор принимает один обязательный параметр $tax_query, который является массивом запросов для таксономии. Он также может принимать необязательный параметр $relation, который определяет логическую связь между запросами.

Метод «__construct()» вызывается автоматически при создании нового объекта WP_Tax_Query.

WP_Tax_Query::__construct( array $tax_query )

Конструктор класса WP_Tax_Query принимает массив $tax_query в качестве параметра. Этот массив содержит запросы для таксономии.

• $tax_query (array, обязательный): Массив запросов для таксономии.
• $relation (string, необязательный): Логическая связь между запросами. Принимает значения ‘AND’ или ‘OR’. По умолчанию установлено значение ‘AND’.
• $0 (array): Массив параметров первого уровня или другой полностью сформированный запрос таксономии.
• $taxonomy (string): Таксономия, по которой выполняется запрос. Необязательно, когда поле равно ‘term_taxonomy_id’.
• $terms (string|int|array): Термин или термины, по которым выполняется фильтрация.
• $field (string): Поле, с которым сравниваются термины. Принимает значения ‘term_id’, ‘slug’, ‘name’ или ‘term_taxonomy_id’. По умолчанию установлено значение ‘term_id’.
• $operator (string): Оператор MySQL, используемый с терминами в предложении WHERE. Принимает значения ‘AND’, ‘IN’, ‘NOT IN’, ‘EXISTS’, ‘NOT EXISTS’. По умолчанию установлено значение ‘IN’.
• $include_children (bool): Включать ли дочерние термины. Требуется указать таксономию. По умолчанию установлено значение true.

<?php
// Создание нового объекта WP_Tax_Query с одним запросом
$tax_query = new WP_Tax_Query( array(
    'taxonomy' => 'category',
    'terms'    => 'php',
    'field'    => 'slug',
) );
// Создание нового объекта WP_Tax_Query с несколькими запросами
$tax_query = new WP_Tax_Query( array(
    'relation' => 'OR',
    array(
        'taxonomy' => 'category',
        'terms'    => 'php',
        'field'    => 'slug',
    ),
    array(
        'taxonomy' => 'post_tag',
        'terms'    => 'wordpress',
        'field'    => 'slug',
    ),
) );
?>

В приведенном выше примере создаются два объекта WP_Tax_Query. Первый объект содержит один запрос для таксономии «category», где термин равен «php» и сравнивается по полю «slug». Второй объект содержит два запроса, где первый запрос для таксономии «category», а второй запрос для таксономии «post_tag». Оба запроса сравниваются по полю «slug» и имеют разные термины.

$args = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'color',
        'field' => 'slug',
        'terms' => array( 'red', 'blue' ),
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'size',
        'field' => 'id',
        'terms' => array( 9, 10, 11 ),
        'operator' => 'NOT IN',
    ),
);
$tax_query = new WP_Tax_Query( $args );

$args = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'color',
        'field' => 'slug',
        'terms' => array( 'red', 'blue' ),
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'size',
        'field' => 'id',
        'terms' => array( 9, 10, 11 ),
        'operator' => 'NOT IN',
    ),
);
$tax_query = new WP_Tax_Query( $args );
$sql = $tax_query->get_sql( 'post', 'ID' );

$args = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'color',
        'field' => 'slug',
        'terms' => array( 'red', 'blue' ),
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'size',
        'field' => 'id',
        'terms' => array( 9, 10, 11 ),
        'operator' => 'NOT IN',
    ),
);
$tax_query = new WP_Tax_Query( $args );
$transformed_query = $tax_query->transform_query( $args );

$args = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'color',
        'field' => 'slug',
        'terms' => array( 'red', 'blue' ),
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'size',
        'field' => 'id',
        'terms' => array( 9, 10, 11 ),
        'operator' => 'NOT IN',
    ),
);
$tax_query = new WP_Tax_Query( $args );
$cleaned_query = $tax_query->clean_query( $args );

$args = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'color',
        'field' => 'slug',
        'terms' => array( 'red', 'blue' ),
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'size',
        'field' => 'id',
        'terms' => array( 9, 10, 11 ),
        'operator' => 'NOT IN',
    ),
);
$tax_query = new WP_Tax_Query( $args );
$table_alias = $tax_query->find_compatible_table_alias( 'color' );

$tax_query = new WP_Tax_Query();

$query = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'color',
        'field' => 'slug',
        'terms' => array( 'red', 'blue' ),
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'size',
        'field' => 'id',
        'terms' => array( 9, 10, 11 ),
        'operator' => 'NOT IN',
    ),
);
$tax_query = new WP_Tax_Query();
$tax_query->clean_query( $query );

$query = array(
    'relation' => 'AND',
    array(
        'taxonomy' => 'color',
        'field' => 'slug',
        'terms' => array( 'red', 'blue' ),
        'operator' => 'IN',
    ),
    array(
        'taxonomy' => 'size',
        'field' => 'id',
        'terms' => array( 9, 10, 11 ),
        'operator' => 'NOT IN',
    ),
);
$tax_query = new WP_Tax_Query();
$tax_query->clean_query( $query );

$args = array(
    'tax_query' => array(
        'relation' => 'AND',
        array(
            'taxonomy' => 'color',
            'field'    => 'slug',
            'terms'    => array( 'red', 'blue' ),
        ),
        array(
            'taxonomy' => 'size',
            'field'    => 'id',
            'terms'    => array( 5, 8 ),
            'operator' => 'NOT IN',
        ),
    ),
);
$query = new WP_Query( $args );

$args = array(
    'tax_query' => array(
        array(
            'taxonomy' => 'color',
            'field'    => 'slug',
            'terms'    => array( 'red', 'blue' ),
        ),
    ),
);
$query = new WP_Query( $args );
$tax_query = $query->tax_query->queries[0];
$sql = $tax_query->get_sql( $wpdb->posts, 'ID' );

$args = array(
    'tax_query' => array(
        array(
            'taxonomy' => 'color',
            'field'    => 'slug',
            'terms'    => array( 'red', 'blue' ),
        ),
    ),
);
$query = new WP_Query( $args );
$tax_query = $query->tax_query->queries[0];
$tax_query->transform_query( 'name', 'slug' );

$query = array(
    array(
        'taxonomy' => 'category',
        'field'    => 'slug',
        'terms'    => 'news',
    ),
);
$tax_query = new WP_Tax_Query( $query );
$is_first_order = $tax_query->is_first_order_clause( $query[0] );
if ( $is_first_order ) {
    echo 'Условие является первого порядка.';
} else {
    echo 'Условие не является первого порядка.';
}

$query = array(
    array(
        'taxonomy' => 'category',
        'field'    => 'slug',
        'terms'    => 'news',
    ),
);
$tax_query = new WP_Tax_Query( $query );
try {
    $clean_query = $tax_query->clean_query( $query );
    echo 'Запрос очищен и проверен успешно.';
} catch ( Exception $e ) {
    echo 'Ошибка: ' . $e->getMessage();
}

$table_name = 'wp_terms';
$table_aliases = array( 't1', 't2', 't3' );
$tax_query = new WP_Tax_Query();
$compatible_alias = $tax_query->find_compatible_table_alias( $table_name, $table_aliases );
if ( $compatible_alias ) {
    echo 'Совместимый псевдоним таблицы: ' . $compatible_alias;
} else {
    echo 'Совместимый псевдоним таблицы не найден.';
}