Source of: /manual/en/function.mb-ereg.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mbstring.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.mb-ereg.php',
1 => 'mb_ereg',
),
'up' =>
array (
0 => 'ref.mbstring.php',
1 => 'Multibyte String Functions',
),
'prev' =>
array (
0 => 'function.mb-ereg-search.php',
1 => 'mb_ereg_search',
),
'next' =>
array (
0 => 'function.mb-eregi-replace.php',
1 => 'mb_eregi_replace',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mb-ereg" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_ereg</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">mb_ereg</span> — <span class="dc-title">Regular expression match with multibyte support</span></p>
</div>
<a name="function.mb-ereg.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>mb_ereg</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pattern</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$string</tt></span>
[, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$regs</tt></span>
] )</div>
<p class="simpara">
Executes the regular expression match with multibyte support.
</p>
</div>
<a name="function.mb-ereg.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">pattern</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The search pattern.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">string</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The search <a href="language.types.string.php" class="type string">string</a>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">regs</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Contains a substring of the matched <a href="language.types.string.php" class="type string">string</a>.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.mb-ereg.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="simpara">
Executes the regular expression
match with multibyte support, and returns <i>1</i> if matches are found.
If the optional <i><tt class="parameter">regs</tt></i>
parameter was specified, the function
returns the byte length of matched part, and the <a href="language.types.array.php" class="type array">array</a>
<i><tt class="parameter">regs</tt></i>
will contain the substring of matched
string. The function returns <i>1</i> if it matches with the empty
string. If no matches are found or an error happens, <b><tt class="constant">FALSE</tt></b> will be
returned.
</p>
</div>
<a name="function.mb-ereg.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<blockquote><p><b class="note">Note</b>: The internal encoding or the
character encoding specified by <a href="function.mb-regex-encoding.php" class="function">mb_regex_encoding()</a>
will be used as the character encoding for this function.<br /></p></blockquote>
</div>
<a name="function.mb-ereg.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.mb-regex-encoding.php" class="function" rel="rdfs-seeAlso">mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li>
<li class="member"><a href="function.mb-eregi.php" class="function" rel="rdfs-seeAlso">mb_eregi()</a> - Regular expression match ignoring case with multibyte support</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
