wppaste
WordPress

get_search_query( bool $escaped = true ): string

Since
2.3.0
Source
wp-includes/general-template.php:4470
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.

Compatibility

WordPress
since 2.3.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

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

Return value

string

Performance profile

How much work a call to get_search_query() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
11–15

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 15.

Plugin surface
1 hook

Third-party callbacks on 'get_search_query' run inside this call, and their cost is not bounded by anything here.

Called by
7

7 places in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_search_query() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always11get_query_var(), apply_filters()
always15get_query_var(), apply_filters(), esc_attr()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 15 instructions, 11–15 executed per call, 1 branch. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

One hook fires while get_search_query() runs, in this order:

  1. apply_filters( get_search_query )filterline 4478 (+8 into the body)

    Filters the contents of the search query variable.

Uses · 3

Used by · 7

Source code

View on Trac View on GitHub 

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

Changelog

Introduced in 2.3.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/general-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.