wppaste
WordPress

wp_robots_noindex_search( array $robots ): array

Since
5.7.0
Source
wp-includes/robots-template.php:118
Adds noindex to the robots meta tag if a search is being performed.

Description

If a search is being performed then noindex will be output to tell web robots not to index the page content. Add this to the 'wp_robots' filter.

Typical usage is as a 'wp_robots' callback:

add_filter( 'wp_robots', 'wp_robots_noindex_search' );

Compatibility

WordPress
since 5.7.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

$robotsarray
Associative array of robots directives.

Return value

array
Filtered robots directives.

Performance profile

How much work a call to wp_robots_noindex_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
Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling
Constant

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

Instructions
5–8

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • optionoption read or writeget_option()one call below wp_robots_noindex_search()

Further down the call graph this can also reach hook, 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 wp_robots_noindex_search() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
!is_search()5is_search()
is_search()8is_search(), wp_robots_no_robots()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 9 instructions, 5–8 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

Source code

View on Trac View on GitHub 

function wp_robots_noindex_search( array $robots ) {	if ( is_search() ) {		return wp_robots_no_robots( $robots );	} 	return $robots;}

Changelog

Introduced in 5.7.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.8.8 tag, from src/wp-includes/robots-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.