Функция THE_SEARCH_QUERY() в WordPress

Функция the_search_query() отображает содержимое переменной, которая хранит поисковой запрос пользователя. Это помогает показать пользователю, что он искал, после отправки поискового запроса.

Что делает функция?

Строка запроса передается через функцию esc_attr(), чтобы убедиться, что она безопасна для использования в HTML-атрибутах. Благодаря этому, вы можете быть уверены в безопасности ваших данных.

П��имеры измерения производительности

• Время выполнения: 1 раз — 0.000017 сек (очень быстро)
• 50000 раз — 0.04 сек (время света)

При тестировании использовалась версия PHP 7.1.2 и WordPress 4.7.3.

Хуки

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

Возвращаемое значение

Функция не возвращает ничего (null).

Как использовать функцию

Чтобы использовать функцию the_search_query(), просто вызовите её в вашем коде:

the_search_query();

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

Пример 1: Отображение поискового запроса в поле поиска

После того как пользователь отправит запрос, мы можем оставить этот запрос в поле, где он был введён (в поисковой форме). Вот как это сделать:

С помощью этого кода, когда пользователь отправляет запрос, он остается в поле поиска.

Пример 2: Отображение поискового запроса на странице

Вы также можете показать поисковой запрос на странице результатов:

Результаты поиска по запросу: "".

История изменений

• С версии 2.1.0: функция была впервые представлена.

Код функции

Если вам интересно, как выглядит реализация функции, вот её код:

function the_search_query() {
/**

• Фильтрует содержимое переменной запроса для отображения.
• @since 2.3.0
• @param mixed $search Содержимое переменной поискового запроса.
  */
  echo esc_attr(apply_filters('the_search_query', get_search_query(false)));
  }

Связанные функции

Вы можете использовать и другие функции в теме WordPress:

• add_theme_support()
• bloginfo()
• body_class()
• И многие другие...

Эти функции помогут вам настраивать различные аспекты вашей темы.

Надеюсь, эта информация была полезна для вас! Если у вас есть вопросы по использованию функции the_search_query(), задавайте их в комментариях.