<!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>Split an array into chunks</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.array-change-key-case.html">array_change_key_case</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.array-column.html">array_column</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.array-chunk" class="refentry">
<div class="refnamediv">
<h1 class="refname">array_chunk</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">array_chunk</span> — <span class="dc-title">Split an array into chunks</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.array-chunk-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>array_chunk</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$array</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$preserve_keys</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Chunks an array into arrays with <em><code class="parameter">size</code></em> elements.
The last chunk may contain less than <em><code class="parameter">size</code></em> elements.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.array-chunk-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">array</code></em></span>
<dd>
<p class="para">
The array to work on
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">size</code></em></span>
<dd>
<p class="para">
The size of each chunk
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">preserve_keys</code></em></span>
<dd>
<p class="para">
When set to <strong><code>TRUE</code></strong> keys will be preserved.
Default is <strong><code>FALSE</code></strong> which will reindex the chunk numerically
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.array-chunk-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a multidimensional numerically indexed array, starting with zero,
with each dimension containing <em><code class="parameter">size</code></em> elements.
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.array-chunk-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
If <em><code class="parameter">size</code></em> is less than 1
<strong><code>E_WARNING</code></strong> will be thrown and <strong><code>NULL</code></strong> returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.array-chunk-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4932">
<p><strong>Example #1 <span class="function"><strong>array_chunk()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$input_array </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'a'</span><span style="color: #007700">, </span><span style="color: #DD0000">'b'</span><span style="color: #007700">, </span><span style="color: #DD0000">'c'</span><span style="color: #007700">, </span><span style="color: #DD0000">'d'</span><span style="color: #007700">, </span><span style="color: #DD0000">'e'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">array_chunk</span><span style="color: #007700">(</span><span style="color: #0000BB">$input_array</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">array_chunk</span><span style="color: #007700">(</span><span style="color: #0000BB">$input_array</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[0] => Array
(
[0] => a
[1] => b
)
[1] => Array
(
[0] => c
[1] => d
)
[2] => Array
(
[0] => e
)
)
Array
(
[0] => Array
(
[0] => a
[1] => b
)
[1] => Array
(
[2] => c
[3] => d
)
[2] => Array
(
[4] => e
)
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.array-chunk-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.array-slice.html" class="function" rel="rdfs-seeAlso">array_slice()</a> - Extract a slice of the 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.array-change-key-case.html">array_change_key_case</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.array-column.html">array_column</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>
