<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.str-ireplace">
<refnamediv>
<refname>str_ireplace</refname>
<refpurpose>Case-insensitive version of <function>str_replace</function>.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>str_ireplace</methodname>
<methodparam><type>mixed</type><parameter>search</parameter></methodparam>
<methodparam><type>mixed</type><parameter>replace</parameter></methodparam>
<methodparam><type>mixed</type><parameter>subject</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">count</parameter></methodparam>
</methodsynopsis>
<para>
This function returns a string or an array with all occurrences of
<parameter>search</parameter> in <parameter>subject</parameter>
(ignoring case) replaced with the given <parameter>replace</parameter>
value. If you don't need fancy replacing rules, you should generally
use this function instead of <function>eregi_replace</function> or
<function>preg_replace</function> with the <literal>i</literal> modifier.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>search</parameter></term>
<listitem>
<note>
<para>
Every replacement with <parameter>search</parameter> array is
performed on the result of previous replacement.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>replace</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>subject</parameter></term>
<listitem>
<para>
If <parameter>subject</parameter> is an array, then the search and
replace is performed with every entry of
<parameter>subject</parameter>, and the return value is an array as
well.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>count</parameter></term>
<listitem>
<para>
The number of matched and replaced <parameter>needles</parameter> will
be returned in <parameter>count</parameter> which is passed by
reference.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
If <parameter>search</parameter> and <parameter>replace</parameter> are
arrays, then <function>str_ireplace</function> takes a value from each
array and uses them to do search and replace on
<parameter>subject</parameter>. If <parameter>replace</parameter> has
fewer values than <parameter>search</parameter>, then an empty string is
used for the rest of replacement values. If <parameter>search</parameter>
is an array and <parameter>replace</parameter> is a string; then this
replacement string is used for every value of
<parameter>search</parameter>.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string or an array of replacements.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.0.0</entry>
<entry>
The <parameter>count</parameter> parameter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>str_ireplace</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$bodytag = str_ireplace("%body%", "black", "<body text=%BODY%>");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function is binary safe.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>str_replace</function></member>
<member><function>preg_replace</function></member>
<member><function>strtr</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->