PHP's str

Str_replace

(PHP 4, PHP 5)

Str_replace-replace all occurrences to the search string with the replacement string

Description

Mixed Str_replace (mixed $search, mixed $replace, mixed $subject[, int &$count] )

This function returns a string or "an array with" occurrences of replaced with the search subject given replace value.

If you don ' t need the fancy replacing rules (like regular expressions), you should always the use this function instead ofpreg_rep Lace ().

Parameters

If search replace and are arrays, then Str_replace () takes a value from all array and uses them to search and replace on . If replace has fewer values than search , then an empty string are used for the rest of replacement values. If search is an array replace and are a string, then this replacement the string is used for every value of search . The converse would not make sense, though.

If search or replace are arrays, their elements are processed.

search

The value being searched for, otherwise known as the needle. An array may is used to designate multiple needles.

replace

The replacement value that replaces found search values. An array may is used to designate multiple replacements.

subject

The string or array being searched and replaced on, otherwise known as the haystack.

If subject is an array, then the search and replace are performed with every entry subject of As.

count

If passed, this is set to the number of replacements performed.

Return Values

This function returns a string or a array with the replaced values.

Changelog

Version	Description
5.0.0	count parameter was added.
4.3.3	the behaviour of this Fu Nction changed. In older versions a bug existed when using arrays as Bothsearch and replace parameters which caused empty search indexes to be skipped without ng the internal pointer on the replace array. This is has been corrected in PHP 4.3.3 and any scripts which the on this bug relied remove should search values empty to call The ING this function is in order to mimic the original behavior.
most parameters can now is an array.

Examples

Example #1 Basic str_replace () examples

// Provides:
$bodytag = str_replace("%body%", "black", "");

// Provides: Hll Wrld f PHP
$vowels = array("a", "e", "i", "o", "u", "A", "E", "I", "O", "U");
$onlyconsonants = str_replace($vowels, "", "Hello World of PHP");

// Provides: You should eat pizza, beer, and ice cream every day
$phrase = "You should eat fruits, vegetables, and fiber every day.";
$healthy = array("fruits", "vegetables", "fiber");
$yummy = array("pizza", "beer", "ice cream");

$newphrase = str_replace($healthy, $yummy, $phrase);

// Provides: 2
$str = str_replace("ll", "", "good golly miss molly!", $count);
echo $count;
?>

Example #2 Examples of potential str_replace () Gotchas

// Order of replacement
$str = "Line 1\nLine 2\rLine 3\r\nLine 4\n";
$order = array("\r\n", "\n", "\r");
$replace = '
';

// Processes \r\n's first so they aren't converted twice.
$newstr = str_replace($order, $replace, $str);

// Outputs F because A is replaced with B, then B is replaced with C, and so on...
// Finally E is replaced with F, because of left to right replacements.
$search = array('A', 'B', 'C', 'D', 'E');
$replace = array('B', 'C', 'D', 'E', 'F');
$subject = 'A';
echo str_replace($search, $replace, $subject);

// Outputs: apearpearle pear
// For the same reason mentioned above
$letters = array('a', 'p');
$fruit = array('apple', 'pear');
$text = 'a p';
$output = str_replace($letters, $fruit, $text);
echo $output;
?>

Notes

Note:this function is Binary-safe.