R3m/framework Function reference string.replace

{string.replace(String | Array $search, String | Array $replace, String | Array $subject='', String $attribute=null)}

Replace all occurrences of the search string with the replacement string.

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

If you don't need fancy replacing rules (like regular expressions), you should use this function instead of {preg.replace()}.

If search and replace are arrays, then {string.replace()} takes a value from each array and uses them to search and replace on subject. 
If replace has fewer values than search, then an empty string is used for the rest of replacement values. 
If search is an array and replace is a string, then this replacement 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 first to last.

    The value being searched for, otherwise known as the needle. 
    An array may be used to designate multiple needles.
    The replacement value that replaces found search values. 
    An array may be used to designate multiple replacements.
    The string or array being searched and replaced on, otherwise known as the haystack. 
    If subject is an array, then the search and replace is performed with every entry of subject, and the return value is an array as well.
    If passed, this will be set to the number of replacements performed.

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

More information:


Last modified: 2021-06-07

© 2021 universeorange.com