<!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>Pad array to the specified length with a value</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.array-multisort.html">array_multisort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.array-pop.html">array_pop</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-pad" class="refentry">
<div class="refnamediv">
<h1 class="refname">array_pad</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">array_pad</span> — <span class="dc-title">Pad array to the specified length with a value</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.array-pad-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>array_pad</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"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>array_pad()</strong></span> returns a copy of the
<em><code class="parameter">array</code></em> padded to size specified by
<em><code class="parameter">size</code></em> with value
<em><code class="parameter">value</code></em>. If
<em><code class="parameter">size</code></em> is positive then the array is
padded on the right, if it's negative then on the left. If the
absolute value of <em><code class="parameter">size</code></em> is less than or
equal to the length of the <em><code class="parameter">array</code></em> then no
padding takes place.
It is possible to add at most 1048576 elements at a time.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.array-pad-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">
Initial array of values to pad.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">size</code></em></span>
<dd>
<p class="para">
New size of the array.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
Value to pad if <em><code class="parameter">array</code></em> is less than
<em><code class="parameter">size</code></em>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.array-pad-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a copy of the <em><code class="parameter">array</code></em> padded to size specified
by <em><code class="parameter">size</code></em> with value
<em><code class="parameter">value</code></em>. If <em><code class="parameter">size</code></em> is
positive then the array is padded on the right, if it's negative then
on the left. If the absolute value of <em><code class="parameter">size</code></em> is less
than or equal to the length of the <em><code class="parameter">array</code></em> then no
padding takes place.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.array-pad-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4970">
<p><strong>Example #1 <span class="function"><strong>array_pad()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$input </span><span style="color: #007700">= array(</span><span style="color: #0000BB">12</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">9</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">array_pad</span><span style="color: #007700">(</span><span style="color: #0000BB">$input</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// result is array(12, 10, 9, 0, 0)<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">array_pad</span><span style="color: #007700">(</span><span style="color: #0000BB">$input</span><span style="color: #007700">, -</span><span style="color: #0000BB">7</span><span style="color: #007700">, -</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// result is array(-1, -1, -1, -1, 12, 10, 9)<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">array_pad</span><span style="color: #007700">(</span><span style="color: #0000BB">$input</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #DD0000">"noop"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// not padded<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.array-pad-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<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"> <span class="function"><a href="function.range.html" class="function" rel="rdfs-seeAlso">range()</a> - Create an array containing a range of elements</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-multisort.html">array_multisort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.array-pop.html">array_pop</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>
