get_search_query( bool $escaped = true ): string

Retrieves the contents of the search WordPress query variable.

Description

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

Parameters

$escapedbooloptional
Whether the result is escaped.
Only use when you are later escaping it. Do not use unescaped.

Default:true

Return

string

Source

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

Hooks

apply_filters( ‘get_search_query’, mixed $search )

Filters the contents of the search query variable.

Changelog

VersionDescription
2.3.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.