<!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>Set the internal pointer of an array to its first element</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.range.html">range</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.rsort.html">rsort</a></div>
<div class="up"><a href="ref.array.html">Array Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.reset" class="refentry">
<div class="refnamediv">
<h1 class="refname">reset</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">reset</span> — <span class="dc-title">Set the internal pointer of an array to its first element</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.reset-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>reset</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$array</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>reset()</strong></span> rewinds <code class="parameter">array</code>'s internal
pointer to the first element and returns the value of the first array
element.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.reset-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">array</code></dt>
<dd>
<p class="para">
The input array.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.reset-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the value of the first array element, or <strong><code>FALSE</code></strong> if the array is
empty.
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code>FALSE</code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code>FALSE</code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>
</div>
<div class="refsect1 examples" id="refsect1-function.reset-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-6247">
<p><strong>Example #1 <span class="function"><strong>reset()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$array </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'step one'</span><span style="color: #007700">, </span><span style="color: #DD0000">'step two'</span><span style="color: #007700">, </span><span style="color: #DD0000">'step three'</span><span style="color: #007700">, </span><span style="color: #DD0000">'step four'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// by default, the pointer is on the first element<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">current</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">) . </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">; </span><span style="color: #FF8000">// "step one"<br /><br />// skip two steps<br /></span><span style="color: #0000BB">next</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">next</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">current</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">) . </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">; </span><span style="color: #FF8000">// "step three"<br /><br />// reset pointer, start again on step one<br /></span><span style="color: #0000BB">reset</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">current</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">) . </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">; </span><span style="color: #FF8000">// "step one"<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.reset-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
The return value for an empty array is indistinguishable from
the return value in case of an array which has a <span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span> <strong><code>FALSE</code></strong>
first element. To properly check the value of the first element of an array
which may contain <strong><code>FALSE</code></strong> elements, first check the <span class="function"><a href="function.count.html" class="function">count()</a></span>
of the array, or check that <span class="function"><a href="function.key.html" class="function">key()</a></span> is not
<strong><code>NULL</code></strong>, after calling <span class="function"><strong>reset()</strong></span>.
</span>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.reset-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.current.html" class="function" rel="rdfs-seeAlso">current()</a> - Return the current element in an array</span></li>
<li class="member"><span class="function"><a href="function.each.html" class="function" rel="rdfs-seeAlso">each()</a> - Return the current key and value pair from an array and advance the array cursor</span></li>
<li class="member"><span class="function"><a href="function.end.html" class="function" rel="rdfs-seeAlso">end()</a> - Set the internal pointer of an array to its last element</span></li>
<li class="member"><span class="function"><a href="function.next.html" class="function" rel="rdfs-seeAlso">next()</a> - Advance the internal pointer of an array</span></li>
<li class="member"><span class="function"><a href="function.prev.html" class="function" rel="rdfs-seeAlso">prev()</a> - Rewind the internal array pointer</span></li>
<li class="member"><span class="function"><a href="function.array-key-first.html" class="function" rel="rdfs-seeAlso">array_key_first()</a> - Gets the first key of an array</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.range.html">range</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.rsort.html">rsort</a></div>
<div class="up"><a href="ref.array.html">Array Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
