<!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>Return the values from a single column in the input array</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.array-chunk.html">array_chunk</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.array-combine.html">array_combine</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-column" class="refentry">
<div class="refnamediv">
<h1 class="refname">array_column</h1>
<p class="verinfo">(PHP 5 >= 5.5.0)</p><p class="refpurpose"><span class="refname">array_column</span> — <span class="dc-title">Return the values from a single column in the input array</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.array-column-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>array_column</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$array</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">$column_key</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">$index_key</code><span class="initializer"> = null</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>array_column()</strong></span> returns the values from a single column of
the <em><code class="parameter">array</code></em>, identified by the
<em><code class="parameter">column_key</code></em>. Optionally, you may provide an
<em><code class="parameter">index_key</code></em> to index the values in the returned array by
the values from the <em><code class="parameter">index_key</code></em> column in the input
array.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.array-column-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">
A multi-dimensional array (record set) from which to pull a column of
values.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">column_key</code></em></span>
<dd>
<p class="para">
The column of values to return. This value may be the integer key of the
column you wish to retrieve, or it may be the string key name for an
associative array. It may also be <strong><code>NULL</code></strong> to return complete arrays
(useful together with <em><code class="parameter">index_key</code></em> to reindex the
array).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">index_key</code></em></span>
<dd>
<p class="para">
The column to use as the index/keys for the returned array. This value
may be the integer key of the column, or it may be the string key name.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.array-column-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of values representing a single column from the input array.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.array-column-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4933">
<p><strong>Example #1 Get column of first names from recordset</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 representing a possible record set returned from a database<br /></span><span style="color: #0000BB">$records </span><span style="color: #007700">= array(<br /> array(<br /> </span><span style="color: #DD0000">'id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">2135</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'first_name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'John'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'last_name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Doe'</span><span style="color: #007700">,<br /> ),<br /> array(<br /> </span><span style="color: #DD0000">'id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3245</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'first_name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Sally'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'last_name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Smith'</span><span style="color: #007700">,<br /> ),<br /> array(<br /> </span><span style="color: #DD0000">'id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">5342</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'first_name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Jane'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'last_name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Jones'</span><span style="color: #007700">,<br /> ),<br /> array(<br /> </span><span style="color: #DD0000">'id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">5623</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'first_name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Peter'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'last_name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Doe'</span><span style="color: #007700">,<br /> )<br />);<br /> <br /></span><span style="color: #0000BB">$first_names </span><span style="color: #007700">= </span><span style="color: #0000BB">array_column</span><span style="color: #007700">(</span><span style="color: #0000BB">$records</span><span style="color: #007700">, </span><span style="color: #DD0000">'first_name'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$first_names</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] => John
[1] => Sally
[2] => Jane
[3] => Peter
)
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-4934">
<p><strong>Example #2
Get column of last names from recordset, indexed by the "id" column
</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">// Using the $records array from Example #1<br /></span><span style="color: #0000BB">$last_names </span><span style="color: #007700">= </span><span style="color: #0000BB">array_column</span><span style="color: #007700">(</span><span style="color: #0000BB">$records</span><span style="color: #007700">, </span><span style="color: #DD0000">'last_name'</span><span style="color: #007700">, </span><span style="color: #DD0000">'id'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$last_names</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
(
[2135] => Doe
[3245] => Smith
[5342] => Jones
[5623] => Doe
)
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.array-chunk.html">array_chunk</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.array-combine.html">array_combine</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>
