<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
<refentry id="function.str-replace">
<refnamediv>
<refname>str_replace</refname>
<refpurpose>
Replace all occurrences of the search string with the replacement string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>str_replace</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>&count</parameter></methodparam>
</methodsynopsis>
<para>
This function returns a string or an array with all occurences of
<parameter>search</parameter> in <parameter>subject</parameter>
replaced with the given <parameter>replace</parameter> value. If
you don't need fancy replacing rules, you should always use this
function instead of <function>ereg_replace</function> or
<function>preg_replace</function>.
</para>
<para>
In PHP 4.0.5 and later, every parameter to
<function>str_replace</function> can be an array.
</para>
<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>
<para>
If <parameter>search</parameter> and
<parameter>replace</parameter> are arrays, then
<function>str_replace</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>
<para>
<example>
<title><function>str_replace</function> example</title>
<programlisting role="php">
<![CDATA[
$bodytag = str_replace("%body%", "black", "<body text=%body%>");
]]>
</programlisting>
</example>
</para>
<para>
This function is binary safe.
</para>
<note>
<para>
<function>str_replace</function> was added in PHP 3.0.6, but was
buggy up until PHP 3.0.8.
</para>
</note>
<note>
<simpara>
As of <literal>PHP 5.0</literal> the number of matched and replaced
<parameter>needle</parameter>s will be returned in
<parameter>count</parameter> which is passed by reference.
</simpara>
</note>
<para>
See also
<function>str_ireplace</function>,
<function>ereg_replace</function>,
<function>preg_replace</function>, and
<function>strtr</function>.
</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
-->