is_search(): bool

Description

Compatibility

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

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

6–12

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

13

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

What it touches

• hookthird-party callbacksdo_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.

Uses · 2

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.

Used by · 13

• 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_breadcrumbs()Renders the `core/breadcrumbs` block on the server.
• 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.

Source code

View on Trac ↗View on GitHub ↗

716function is_search() {717	global $wp_query;718 719	if ( ! isset( $wp_query ) ) {720		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );721		return false;722	}723 724	return $wp_query->is_search();725}

Changelog

Introduced in 1.5.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 7.1.0 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.