A WordPress-centric search engine for devs and theme authors



get_search_query ›

Since2.3.0
Deprecatedn/a
get_search_query ( $escaped = true )
Parameters:
  • (bool) $escaped Whether the result is escaped. Default true. Only use when you are later escaping it. Do not use unescaped.
    Required: No
    Default: true
Returns:
  • (string)
Defined at:
Codex:

Retrieves the contents of the search WordPress query variable.

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



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