set_query_var()
Устанавливает параметр запроса в глобальную переменную $wp_query.
Устанавливается переменная, которая находится в свойстве объекта $wp_query->query_vars. Эти параметры можно получить с помощью get_query_var() или так:
global $wp_query; $wp_query->query_vars[ $query_var ]
1 раз — 0.000015 сек (очень быстро) | 50000 раз — 0.01 сек (скорость света) | PHP 7.0.2, WP 4.4.1
Хуков нет.
Возвращает
null. Ничего.
Использование
set_query_var( $var, $value );
- $var(строка) (обязательный)
- Название параметра. Ключ.
- $value(смешанный) (обязательный)
- Значение параметра.
Примеры
#1 Передача переменной в файл шаблона
Использовать установку параметра можно например для передачи данных в файл шаблона при вызове его с помощью функции get_template_part().
// When calling a template with get_template_part() set_query_var( 'my_form_id', 23 ); get_template_part( 'my-form-template' );
Теперь в коде файла шаблона данные можно получить так:
// Inside my-form-template.php
$my_form_id = get_query_var('my_form_id');
С версии WP 5.5 передавать данные в файл шаблона можно через третий параметр функции get_template_part().
#2 Установим параметр запроса, а затем получим его
// установим set_query_var( 'comments_per_page', 20 ); // получим $var = get_query_var( 'comments_per_page' ); echo $var; // 20
Заметки
- Global. WP_Query. $wp_query WordPress Query object.
Список изменений
| С версии 2.2.0 | Введена. |
Код set_query_var() set query var WP 6.8.1
function set_query_var( $query_var, $value ) {
global $wp_query;
$wp_query->set( $query_var, $value );
}