<!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>Create an array containing a range of elements</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.prev.html">prev</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.reset.html">reset</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.range" class="refentry">
<div class="refnamediv">
<h1 class="refname">range</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">range</span> — <span class="dc-title">Create an array containing a range of elements</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.range-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>range</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$start</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$end</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.number" class="type number">number</a></span> <code class="parameter">$step</code><span class="initializer"> = 1</span></span>
] )</div>
<p class="para rdfs-comment">
Create an array containing a range of elements.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.range-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">start</code></em></span>
<dd>
<p class="para">
First value of the sequence.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">end</code></em></span>
<dd>
<p class="para">
The sequence is ended upon reaching the
<em><code class="parameter">end</code></em> value.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">step</code></em></span>
<dd>
<p class="para">
If a <em><code class="parameter">step</code></em> value is given, it will be used as the
increment between elements in the sequence. <em><code class="parameter">step</code></em>
should be given as a positive number. If not specified,
<em><code class="parameter">step</code></em> will default to 1.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.range-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of elements from <em><code class="parameter">start</code></em> to
<em><code class="parameter">end</code></em>, inclusive.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.range-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.0.0</td>
<td>
The optional <em><code class="parameter">step</code></em> parameter was added.
</td>
</tr>
<tr>
<td>4.1.0 to 4.3.2</td>
<td>
In PHP versions 4.1.0 through 4.3.2, <span class="function"><strong>range()</strong></span> sees
numeric strings as strings and not integers. Instead, they will be
used for character sequences. For example, <em>"4242"</em>
is treated as <em>"4"</em>.
</td>
</tr>
<tr>
<td>4.1.0</td>
<td>
Prior to PHP 4.1.0, <span class="function"><strong>range()</strong></span> only generated
incrementing integer arrays. Support for character sequences and
decrementing arrays was added in 4.1.0. Character sequence values
are limited to a length of one. If a length greater than one is
entered, only the first character is used.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.range-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5028">
<p><strong>Example #1 <span class="function"><strong>range()</strong></span> examples</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12)<br /></span><span style="color: #007700">foreach (</span><span style="color: #0000BB">range</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">12</span><span style="color: #007700">) as </span><span style="color: #0000BB">$number</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$number</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// The step parameter was introduced in 5.0.0<br />// array(0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100)<br /></span><span style="color: #007700">foreach (</span><span style="color: #0000BB">range</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">) as </span><span style="color: #0000BB">$number</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$number</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// Use of character sequences introduced in 4.1.0<br />// array('a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i');<br /></span><span style="color: #007700">foreach (</span><span style="color: #0000BB">range</span><span style="color: #007700">(</span><span style="color: #DD0000">'a'</span><span style="color: #007700">, </span><span style="color: #DD0000">'i'</span><span style="color: #007700">) as </span><span style="color: #0000BB">$letter</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$letter</span><span style="color: #007700">;<br />}<br /></span><span style="color: #FF8000">// array('c', 'b', 'a');<br /></span><span style="color: #007700">foreach (</span><span style="color: #0000BB">range</span><span style="color: #007700">(</span><span style="color: #DD0000">'c'</span><span style="color: #007700">, </span><span style="color: #DD0000">'a'</span><span style="color: #007700">) as </span><span style="color: #0000BB">$letter</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$letter</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.range-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.shuffle.html" class="function" rel="rdfs-seeAlso">shuffle()</a> - Shuffle an array</span></li>
<li class="member"> <span class="function"><a href="function.array-fill.html" class="function" rel="rdfs-seeAlso">array_fill()</a> - Fill an array with values</span></li>
<li class="member"><a href="control-structures.foreach.html" class="link">foreach</a></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.prev.html">prev</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.reset.html">reset</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>
