Функция get_search_query() используется для получения строки поискового запроса, который был введен пользователем. Эта функция удобна для отображения поисковых запросов в шаблонах и может принимать несколько параметров для настройки вывода.
get_search_query( $escaped = true )Параметры
- $escaped (boolean, необязательный): Определяет, следует ли экранировать строку поиска для безопасного вывода. По умолчанию
true.
Возвращаемое значение
- (строка): Возвращает строку поискового запроса.
Примеры использования
Пример 1: Вывод поискового запроса
Этот пример показывает, как вывести строку поискового запроса на странице результатов поиска.
if ( is_search() ) {
echo 'Вы искали: ' . get_search_query();
}Пример 2: Отображение поискового запроса в форме поиска
Этот пример демонстрирует, как автоматически заполнить поле ввода формы поиска текущим поисковым запросом.
<form role="search" method="get" class="search-form" action="<?php echo home_url( '/' ); ?>">
<label>
<span class="screen-reader-text"><?php echo _x( 'Search for:', 'label' ) ?></span>
<input type="search" class="search-field" value="<?php echo get_search_query(); ?>" name="s" />
</label>
<input type="submit" class="search-submit" value="<?php echo esc_attr_x( 'Search', 'submit button' ) ?>" />
</form>
Пример 3: Получение необработанного поискового запроса
Если вам нужно получить поисковый запрос без экранирования, передайте параметр false в функцию get_search_query().
$raw_search_query = get_search_query( false );
echo 'Необработанный поисковый запрос: ' . $raw_search_query;Пример 4: Использование поискового запроса в заголовке страницы
Вы можете использовать get_search_query() для отображения поискового запроса в заголовке страницы результатов поиска.
if ( is_search() ) {
echo '<h1>Результаты поиска для: ' . get_search_query() . '</h1>';
}Заключение
Функция get_search_query() является важным инструментом для работы с поисковыми запросами в WordPress. Она позволяет легко и безопасно получить и отобразить поисковый запрос пользователя, что делает её незаменимой для создания пользовательских форм поиска и отображения результатов.