php-doc-en/reference/mbstring/functions/mb-ereg-replace.xml
2004-08-28 13:34:36 +00:00

71 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry id="function.mb-ereg-replace">
<refnamediv>
<refname>mb_ereg_replace</refname>
<refpurpose>Replace regular expression with multibyte support</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>mb_ereg_replace</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>replacement</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt">
<type>array</type><parameter>option</parameter>
</methodparam>
</methodsynopsis>
<simpara>
<function>mb_ereg_replace</function> scans
<parameter>string</parameter> for matches to
<parameter>pattern</parameter>, then replaces the matched text
with <parameter>replacement</parameter> and returns the result
string or &false; on error. Multibyte character can be used in
<parameter>pattern</parameter>.
</simpara>
<simpara>
Matching condition can be set by <parameter>option</parameter>
parameter. If <literal>i</literal> is specified for this
parameter, the case will be ignored. If <literal>x</literal> is
specified, white space will be ignored. If <literal>m</literal>
is specified, match will be executed in multiline mode and line
break will be included in '.'. If <literal>p</literal> is
specified, match will be executed in POSIX mode, line break
will be considered as normal character. If <literal>e</literal>
is specified, <parameter>replacement</parameter> string will be
evaluated as PHP expression.
</simpara>
<para>
The internal encoding or the character encoding specified in
<function>mb_regex_encoding</function> will be used as character
encoding.
</para>
<para>
See also: <function>mb_regex_encoding</function>,
<function>mb_eregi_replace</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
-->