get_search_query() │ WP 2.3.0

Получает поисковой запрос (строку).

Запрос обрабатывается функцией esc_attr(), чтобы его можно было использовать в качестве атрибута html тега.

Основа для: get_search_link(), the_search_query()

Хуки из функции

get_search_query

Возвращает

Строку. Поисковой запрос.

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

get_search_query( $escaped );

$escaped(логический): Очищать результат (true) или нет (false). Если используете false убедитесь, чтобы перед выводом строка была очищена с помощью esc_attr(). Не выводите строку не очищенной.
По умолчанию: true

Примеры

#1 Выведем строку запроса поиска

Допустим, пользователь искал слово "wordpress", тогда этот код на странице вывода результатов поиска выведет это слово:

<?php echo get_search_query(); ?>

#2 Результат в переменную

Когда нужно получить результат в переменную, используем такой вариант:

$search_query = get_search_query();

#3 Пробелы в строке поиска

Функция не удаляет пробелы на концах в строке поиска. Например:

// в поиске указана строка с пробелами на концах " mail me "
get_search_query(); // ` mail me `

Удалить пробелы можно так:

$squery = trim( get_search_query() );

Список изменений

С версии 2.3.0

Введена.

Код `get_search_query() get search query` ^{WP 6.3.1}

wp-includes/general-template.php

function get_search_query( $escaped = true ) {
	/**
	 * Filters the contents of the search query variable.
	 *
	 * @since 2.3.0
	 *
	 * @param mixed $search Contents of the search query variable.
	 */
	$query = apply_filters( 'get_search_query', get_query_var( 's' ) );

	if ( $escaped ) {
		$query = esc_attr( $query );
	}
	return $query;
}