WP_Query::get_search_stopwords(): string[]

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

string[]

Stopwords.

Performance profile

How much work a call to WP_Query::get_search_stopwords() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

4–23

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

Plugin surface

1 hook

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

Called by

1

1 place 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 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 WP_Query::get_search_stopwords() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   apply_filters( wp_search_stopwords )filterline 1625 (+33 into the body)

   Filters stopwords used when parsing search terms.

Uses · 2

• _x()Retrieves translated string with gettext context.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• WP_Query::parse_search_terms()Checks if the terms are suitable for searching.

Source code

View on Trac ↗View on GitHub ↗

1592	protected function get_search_stopwords() {1593		if ( isset( $this->stopwords ) ) {1594			return $this->stopwords;1595		}1596 1597		/*1598		 * translators: This is a comma-separated list of very common words that should be excluded from a search,1599		 * like a, an, and the. These are usually called "stopwords". You should not simply translate these individual1600		 * words into your language. Instead, look for and provide commonly accepted stopwords in your language.1601		 */1602		$words = explode(1603			',',1604			_x(1605				'about,an,are,as,at,be,by,com,for,from,how,in,is,it,of,on,or,that,the,this,to,was,what,when,where,who,will,with,www',1606				'Comma-separated list of search stopwords in your language'1607			)1608		);1609 1610		$stopwords = array();1611		foreach ( $words as $word ) {1612			$word = trim( $word, "\r\n\t " );1613			if ( $word ) {1614				$stopwords[] = $word;1615			}1616		}1617 1618		/**1619		 * Filters stopwords used when parsing search terms.1620		 *1621		 * @since 3.7.01622		 *1623		 * @param string[] $stopwords Array of stopwords.1624		 */1625		$this->stopwords = apply_filters( 'wp_search_stopwords', $stopwords );1626		return $this->stopwords;1627	}

Changelog

Introduced in 3.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 7.1.0 tag, from src/wp-includes/class-wp-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.