get_search_query() — описание функции WordPress на русском

Сигнатура

get_search_query( bool $escaped = true ): string

Описание

Строка поискового запроса пропускается через esc_attr(), чтобы гарантировать её безопасность для размещения в HTML-атрибуте.

Оригинал (английский)

The search query string is passed through esc_attr() to ensure that it is safe for placing in an HTML attribute.

Параметры

$escaped bool необязательный = true

Экранировать ли результат. Используйте только если экранируете его позже. Не используйте без экранирования.

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

string

Исходный код

wp-includes/general-template.php:4493

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;
}

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

Версия	Описание
2.3.0	Introduced.