wptexturize_primes( string $haystack, string $needle, string $prime, string $open_quote, string $close_quote ): string

Compatibility

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

Parameters

$haystackstring

The plain text to be searched.

$needlestring

The character to search for such as ' or ".

$primestring

The prime char to use for replacement.

$open_quotestring

The opening quote char. Opening quote replacement must be accomplished already.

$close_quotestring

The closing quote char to use for replacement.

Return value

string

The $haystack value after primes and quotes replacements.

Performance profile

How much work a call to wptexturize_primes() 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 what you pass in.

Instructions

25–26

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

Plugin surface

None

Nothing here hands control to plugin code.

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()one call below wptexturize_primes()

What one call costs · 1 distinct outcome

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

Uses · 2

• wp_spaces_regexp()Returns the regexp for common whitespace characters.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.

Used by · 1

• wptexturize()Replaces common plain text characters with formatted entities.

Source code

View on Trac ↗View on GitHub ↗

320function wptexturize_primes( $haystack, $needle, $prime, $open_quote, $close_quote ) {321	$spaces           = wp_spaces_regexp();322	$flag             = '<!--wp-prime-or-quote-->';323	$quote_pattern    = "/$needle(?=\\Z|[.,:;!?)}\\-\\]]|&gt;|" . $spaces . ')/';324	$prime_pattern    = "/(?<=\\d)$needle/";325	$flag_after_digit = "/(?<=\\d)$flag/";326	$flag_no_digit    = "/(?<!\\d)$flag/";327 328	$sentences = explode( $open_quote, $haystack );329 330	foreach ( $sentences as $key => &$sentence ) {331		if ( ! str_contains( $sentence, $needle ) ) {332			continue;333		} elseif ( 0 !== $key && 0 === substr_count( $sentence, $close_quote ) ) {334			$sentence = preg_replace( $quote_pattern, $flag, $sentence, -1, $count );335			if ( $count > 1 ) {336				// This sentence appears to have multiple closing quotes. Attempt Vulcan logic.337				$sentence = preg_replace( $flag_no_digit, $close_quote, $sentence, -1, $count2 );338				if ( 0 === $count2 ) {339					// Try looking for a quote followed by a period.340					$count2 = substr_count( $sentence, "$flag." );341					if ( $count2 > 0 ) {342						// Assume the rightmost quote-period match is the end of quotation.343						$pos = strrpos( $sentence, "$flag." );344					} else {345						/*346						 * When all else fails, make the rightmost candidate a closing quote.347						 * This is most likely to be problematic in the context of bug #18549.348						 */349						$pos = strrpos( $sentence, $flag );350					}351					$sentence = substr_replace( $sentence, $close_quote, $pos, strlen( $flag ) );352				}353				// Use conventional replacement on any remaining primes and quotes.354				$sentence = preg_replace( $prime_pattern, $prime, $sentence );355				$sentence = preg_replace( $flag_after_digit, $prime, $sentence );356				$sentence = str_replace( $flag, $close_quote, $sentence );357			} elseif ( 1 === $count ) {358				// Found only one closing quote candidate, so give it priority over primes.359				$sentence = str_replace( $flag, $close_quote, $sentence );360				$sentence = preg_replace( $prime_pattern, $prime, $sentence );361			} else {362				// No closing quotes found. Just run primes pattern.363				$sentence = preg_replace( $prime_pattern, $prime, $sentence );364			}365		} else {366			$sentence = preg_replace( $prime_pattern, $prime, $sentence );367			$sentence = preg_replace( $quote_pattern, $close_quote, $sentence );368		}369		if ( '"' === $needle && str_contains( $sentence, '"' ) ) {370			$sentence = str_replace( '"', $close_quote, $sentence );371		}372	}373 374	return implode( $open_quote, $sentences );375}

Changelog

Introduced in 4.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.7.7 tag, from src/wp-includes/formatting.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.