The str_replace() is a built-in function in PHP and is used to replace all the occurrences of the search string or array of search strings by replacement string or array of replacement strings in the given string or array respectively.
str_replace ( $searchVal, $replaceVal, $subjectVal, $count )
Parameters: This function accepts four parameters out of which 3 are mandatory and 1 is optional. All of these parameters are described below:
- $searchVal: This parameter can be of both string and array types. This parameter specifies the string to be searched and replaced.
- $replaceVal: This parameter can be of both string and array types. This parameter specifies the string with which we want to replace the $searchVal string.
- $subjectVal: This parameter can be of both string and array types. This parameter specifies the string or array of strings which we want to search for $searchVal and replace with $replaceVal.
- $count: This parameter is optional and if passed, it’s value will be set to the total number of replacement operations performed on the string $subjectVal.
If the $searchVal and the $replaceVal arguments are arrays, then all the elements of the $searchVal argument are searched in the $subjectVal string and replaced by the corresponding elements in the $replaceVal argument. If number of elements in $replaceVal is less than that in $searchVal array, then if there are any occurences of the additional elements of $searchVal argument in the $subjectVal argument then they will be replaced by an empty string. If the $subjectVal parameter is also an array instead of string then all of the elements of $subjectVal will be searched.
Return Value: This function returns a string or an array based on the $subjectVal parameter with replaced values.
Input: $subjectVal = "It was nice meeting you. May you shine brightly." str_replace('you', 'him', $subjectVal) Output: It was nice meeting him. May him shine brightly. Input: $subjectVal = "You eat fruits, vegetables, fiber every day." $searchVal = array("fruits", "vegetables", "fiber") $replaceVal = array("pizza", "beer", "ice cream") str_replace($array1, $array2, $str) Output: You eat pizza, beer, ice cream every day.
In the first example every occurrence of you is replaced with him. In the second example since both the arguments are arrays, therefore, every element from the first argument is replaced with the corresponding element from the second argument as explained above.
Below programs illustate the str_replace() function in PHP:
Example – 1:
It was nice meeting him. May him shine bright.
Example – 2:
You eat pizza, beer, ice cream every day.