wppaste
WordPress

_deep_replace( string|array $search, string $subject ): string

Since
2.8.1
Source
wp-includes/formatting.php:4427
Performs a deep string replace operation to ensure the values in $search are no longer present.

Description

Repeats the replacement operation until it no longer replaces anything to remove "nested" values e.g. $subject = '%0%0%0DDD', $search ='%0D', $result ='' rather than the '%0%0DD' that str_replace would return

Compatibility

WordPress
since 2.8.1
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

$searchstring|array
The value being searched for, otherwise known as the needle.
An array may be used to designate multiple needles.
$subjectstring
The string being searched and replaced on, otherwise known as the haystack.

Return value

string
The string with the replaced values.

Performance profile

How much work a call to _deep_replace() 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
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
8

Executed per call on PHP 8.5. The body compiles to 15.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

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 _deep_replace() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always8none

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, 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.

Used by · 2

Source code

View on Trac View on GitHub 

function _deep_replace( $search, $subject ) {	$subject = (string) $subject; 	$count = 1;	while ( $count ) {		$subject = str_replace( $search, '', $subject, $count );	} 	return $subject;}

Changelog

Introduced in 2.8.1. 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/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.