Source of: /manual/en/function.mb-stristr.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-stristr.php',
1 => 'mb_stristr',
),
'up' =>
array (
0 => 'ref.mbstring.php',
1 => 'Multibyte String Functions',
),
'prev' =>
array (
0 => 'function.mb-stripos.php',
1 => 'mb_stripos',
),
'next' =>
array (
0 => 'function.mb-strlen.php',
1 => 'mb_strlen',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mb-stristr" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_stristr</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">mb_stristr</span> — <span class="dc-title">Finds first occurrence of a string within another, case insensitive</span></p>
</div>
<a name="function.mb-stristr.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>mb_stristr</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$haystack</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$needle</tt></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$part</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$encoding</tt></span>
]] )</div>
<p class="para rdfs-comment">
<b>mb_stristr()</b> finds the first occurrence of
<i><tt class="parameter">needle</tt></i>
in <i><tt class="parameter">haystack</tt></i>
and returns the portion of <i><tt class="parameter">haystack</tt></i>
.
Unlike <a href="function.mb-strstr.php" class="function">mb_strstr()</a>,
<b>mb_stristr()</b> is case-insensitive.
If <i><tt class="parameter">needle</tt></i>
is not found, it returns <b><tt class="constant">FALSE</tt></b>.
</p>
</div>
<a name="function.mb-stristr.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">haystack</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The string from which to get the first occurrence
of <i><tt class="parameter">needle</tt></i>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">needle</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The string to find in <i><tt class="parameter">haystack</tt></i>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">part</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Determines which portion of <i><tt class="parameter">haystack</tt></i>
this function returns.
If set to <b><tt class="constant">TRUE</tt></b>, it returns all of <i><tt class="parameter">haystack</tt></i>
from the beginning to the first occurrence of <i><tt class="parameter">needle</tt></i>
.
If set to <b><tt class="constant">FALSE</tt></b>, it returns all of <i><tt class="parameter">haystack</tt></i>
from the first occurrence of <i><tt class="parameter">needle</tt></i>
to the end,
Default value is <b><tt class="constant">FALSE</tt></b>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">encoding</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Character encoding name to use.
If it is omitted, internal character encoding is used.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.mb-stristr.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the portion of <i><tt class="parameter">haystack</tt></i>
,
or <b><tt class="constant">FALSE</tt></b> if <i><tt class="parameter">needle</tt></i>
is not found.
</p>
</div>
<a name="function.mb-stristr.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.stristr.php" class="function" rel="rdfs-seeAlso">stristr()</a> - Case-insensitive strstr</li>
<li class="member"><a href="function.strstr.php" class="function" rel="rdfs-seeAlso">strstr()</a> - Find first occurrence of a string</li>
<li class="member"><a href="function.mb-strstr.php" class="function" rel="rdfs-seeAlso">mb_strstr()</a> - Finds first occurrence of a string within another</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
