Функция get_search_query() в WordPress: синтаксис и примеры использования

## Функция GET_SEARCH_QUERY() ��� WP 2.3.0

Функция get_search_query() позволяет получить текст, который пользователь ввел в строку поиска WordPress. Этот текст проходит проверку через функцию esc_attr(), что помогает убедиться, что он безопасен для вывода в HTML.

### Использование функции

Эта функция может применять следующие функции: get_search_link() и the_search_query().

### Хуки в функции

- get_search_query

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

Функция возвращает строку с поисковым запросом.

### Применение

Чтобы использовать функцию, напишите следующий код:

```php
get_search_query( $escaped );

• $escaped (true|false) — указывает, нужно ли экранировать результат. Используйте это значение, если вы собираетесь экранировать результат позже. Не используйте неэкранированные данные.
• По умолчанию: 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():

function get_search_query( $escaped = true ) {
/**

• Фильтрует содержимое переменной поискового запроса.
• @since 2.3.0

• @param mixed $search Содержимое переменной поискового запроса.
  */
  $query = apply_filters( 'get_search_query', get_query_var( 's' ) );

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

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

• add_query_arg()
• get_queried_object()
• get_queried_object_id()
• get_query_var()
• get_status_header_desc()
• is_embed()
• is_robots()
• redirect_canonical()
• remove_query_arg()
• wp()

Заключение

Функция get_search_query() — это полезный инструмент для получения поисковых запросов в WordPress. С ее помощью вы можете удобно обрабатывать запросы пользователей и выводить их на экран.