WordPress at a glance

get_search_query() WP 1.0

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.

Is the basis for: the_search_query()
Hooks from function:
Return

String.

Usage

get_search_query( $escaped );
$escaped(true/false)
Whether the result is escaped. Only use when you are later escaping it. Do not use unescaped.
Default: true

Code of get_search_query: wp-includes/general-template.php VER 4.9.8

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

Related Functions

From category: Main Query

More from Template Tags: Links (URL)

No comments
    Hello, !     Log In . Register