Description
This function returns a string or an array with all occurrences of
search
in subject
(ignoring case) replaced with the given replace
value. If you don't need fancy replacing rules, you should generally
use this function instead of
preg_replace() with the i modifier.
Parameters
If search
and replace
are
arrays, then str_ireplace() 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.
-
search
-
The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.
-
replace
-
The replacement value that replaces found
search
values. An array may be 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 is performed with every entry ofsubject
, and the return value is an array as well. -
count
-
If passed, this will be set to the number of replacements performed.
Examples
Example #1 str_ireplace() example
<?php
$bodytag = str_ireplace("%body%", "black", "<body text=%BODY%>");
echo $bodytag; // <body text=black>
?>
Notes
Note: This function is binary-safe.
Replacement order gotcha
Because str_ireplace() replaces left to right, it might replace a previously inserted value when doing multiple replacements. Example #2 in the str_replace() documentation demonstrates how this may affect you in practice.
See Also
- str_replace() - Replace all occurrences of the search string with the replacement string
- preg_replace() - Perform a regular expression search and replace
- strtr() - Translate characters or replace substrings
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-str-ireplace.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.