is_search(): bool
- Since
- 1.5.0
- Source
wp-includes/query.php:696
Description
For more information on this and similar theme functions, check out the https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags article in the Theme Developer Handbook.
Compatibility
- WordPress
- since 1.5.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.
Return value
bool- Whether the query is for a search.
Performance profile
How much work a call to is_search() 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
- Scaling
- Constant
- Instructions
- 6–12
- Plugin surface
- None
- Called by
- 12
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 15.
Nothing here hands control to plugin code.
12 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()one call below is_search()
Further down the call graph this can also reach query, option, cache, serialize 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 is_search() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
isset($wp_query) | 6 | ->is_search() |
!isset($wp_query) | 12 | __(), _doing_it_wrong() |
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, 6–12 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.
Uses · 2
- _doing_it_wrong()Marks something as being incorrectly called.
- __()Retrieves the translation of $text.
Used by · 12
- WP::handle_404()Set the Headers for 404, if nothing is found for requested URL.
- feed_links_extra()Displays the links to the extra feeds such as category feeds.
- get_body_class()Retrieves an array of the class names for the body element.
- redirect_canonical()Redirects incoming links to the proper URL based on the site url.
- render_block_core_query_title()Renders the `core/query-title` block on the server.
- twentyfourteen_body_classes()Extends the default WordPress body classes.
- twentyseventeen_content_image_sizes_attr()Adds custom image sizes attribute to enhance responsive image functionality for content images.
- twentyseventeen_post_thumbnail_sizes_attr()Adds custom image sizes attribute to enhance responsive image functionality for post thumbnails.
- twentysixteen_excerpt()Displays the optional excerpt.
- wp_get_document_title()Returns document title for the current page.
- wp_robots_noindex_search()Adds `noindex` to the robots meta tag if a search is being performed.
- wp_title()Displays or retrieves page title for all areas of blog.
Source code
function is_search() { global $wp_query; if ( ! isset( $wp_query ) ) { _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } return $wp_query->is_search();}Changelog
Introduced in 1.5.0. Unchanged from 6.7.7 through 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/query.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.