<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Case insensitive regular expression match</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.eregi-replace.html">eregi_replace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.split.html">split</a></div>
<div class="up"><a href="ref.regex.html">POSIX Regex Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.eregi" class="refentry">
<div class="refnamediv">
<h1 class="refname">eregi</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">eregi</span> — <span class="dc-title">Case insensitive regular expression match</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.eregi-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>eregi</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$pattern</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$string</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$regs</code></span>
] )</div>
<p class="para rdfs-comment">
This function is identical to <span class="function"><a href="function.ereg.html" class="function">ereg()</a></span> except that it
ignores case distinction when matching alphabetic characters.
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function has been
<em class="emphasis">DEPRECATED</em> as of PHP 5.3.0. Relying on this feature is
highly discouraged.</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-function.eregi-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">pattern</code></em></span>
<dd>
<p class="para">
Case insensitive regular expression.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">string</code></em></span>
<dd>
<p class="para">
The input string.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">regs</code></em></span>
<dd>
<p class="para">
If matches are found for parenthesized substrings of
<em><code class="parameter">pattern</code></em> and the function is called with the
third argument <em><code class="parameter">regs</code></em>, the matches will be stored
in the elements of the array <em><code class="parameter">regs</code></em>.
</p>
<p class="para">
$regs[1] will contain the substring which starts at the first left
parenthesis; $regs[2] will contain the substring starting at the
second, and so on. $regs[0] will contain a copy of the complete string
matched.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.eregi-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the length of the matched string if a match for
<em><code class="parameter">pattern</code></em> was found in <em><code class="parameter">string</code></em>,
or <strong><code>FALSE</code></strong> if no matches were found or an error occurred.
</p>
<p class="para">
If the optional parameter <em><code class="parameter">regs</code></em> was not passed or
the length of the matched string is 0, this function returns 1.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.eregi-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4811">
<p><strong>Example #1 <span class="function"><strong>eregi()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$string </span><span style="color: #007700">= </span><span style="color: #DD0000">'XYZ'</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">eregi</span><span style="color: #007700">(</span><span style="color: #DD0000">'z'</span><span style="color: #007700">, </span><span style="color: #0000BB">$string</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"'</span><span style="color: #0000BB">$string</span><span style="color: #DD0000">' contains a 'z' or 'Z'!"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.eregi-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">As of PHP 5.3.0, the
regex extension is deprecated in favor of the
<a href="book.pcre.html" class="link">PCRE extension</a>. Calling this function
will issue an <strong><code>E_DEPRECATED</code></strong> notice. See <a href="reference.pcre.pattern.posix.html" class="link">the list of
differences</a> for help on converting to PCRE.</p></p></blockquote>
<div class="tip"><strong class="tip">Tip</strong>
<p class="para">
<span class="function"><strong>eregi()</strong></span> is deprecated as of PHP 5.3.0. <span class="function"><a href="function.preg-match.html" class="function">preg_match()</a></span>
with the <em>i</em> (<strong><code>PCRE_CASELESS</code></strong>) modifier is the suggested alternative.
</p>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-function.eregi-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ereg.html" class="function" rel="rdfs-seeAlso">ereg()</a> - Regular expression match</span></li>
<li class="member"> <span class="function"><a href="function.ereg-replace.html" class="function" rel="rdfs-seeAlso">ereg_replace()</a> - Replace regular expression</span></li>
<li class="member"> <span class="function"><a href="function.eregi-replace.html" class="function" rel="rdfs-seeAlso">eregi_replace()</a> - Replace regular expression case insensitive</span></li>
<li class="member"> <span class="function"><a href="function.preg-match.html" class="function" rel="rdfs-seeAlso">preg_match()</a> - Perform a regular expression match</span></li>
<li class="member"> <span class="function"><a href="function.stripos.html" class="function" rel="rdfs-seeAlso">stripos()</a> - Find the position of the first occurrence of a case-insensitive substring in a string</span></li>
<li class="member"> <span class="function"><a href="function.stristr.html" class="function" rel="rdfs-seeAlso">stristr()</a> - Case-insensitive strstr</span></li>
<li class="member"> <span class="function"><a href="function.quotemeta.html" class="function" rel="rdfs-seeAlso">quotemeta()</a> - Quote meta characters</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.eregi-replace.html">eregi_replace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.split.html">split</a></div>
<div class="up"><a href="ref.regex.html">POSIX Regex Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
