<!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>Sort an array by key</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.krsort.html">krsort</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.list.html">list</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.ksort" class="refentry"> <div class="refnamediv"> <h1 class="refname">ksort</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ksort</span> — <span class="dc-title">Sort an array by key</span></p> </div> <div class="refsect1 description" id="refsect1-function.ksort-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>ksort</strong></span> ( <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$array</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$sort_flags</code><span class="initializer"> = SORT_REGULAR</span></span> ] )</div> <p class="para rdfs-comment"> Sorts an array by key, maintaining key to data correlations. This is useful mainly for associative arrays. </p> </div> <div class="refsect1 parameters" id="refsect1-function.ksort-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 input array. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">sort_flags</code></em></span> <dd> <p class="para"> You may modify the behavior of the sort using the optional parameter <em><code class="parameter">sort_flags</code></em>, for details see <span class="function"><a href="function.sort.html" class="function">sort()</a></span>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.ksort-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.ksort-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-5018"> <p><strong>Example #1 <span class="function"><strong>ksort()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$fruits </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"d"</span><span style="color: #007700">=></span><span style="color: #DD0000">"lemon"</span><span style="color: #007700">, </span><span style="color: #DD0000">"a"</span><span style="color: #007700">=></span><span style="color: #DD0000">"orange"</span><span style="color: #007700">, </span><span style="color: #DD0000">"b"</span><span style="color: #007700">=></span><span style="color: #DD0000">"banana"</span><span style="color: #007700">, </span><span style="color: #DD0000">"c"</span><span style="color: #007700">=></span><span style="color: #DD0000">"apple"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ksort</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruits</span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">$fruits </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$key</span><span style="color: #DD0000"> = </span><span style="color: #0000BB">$val</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<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> a = orange b = banana c = apple d = lemon </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.ksort-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.asort.html" class="function" rel="rdfs-seeAlso">asort()</a> - Sort an array and maintain index association</span></li> <li class="member">The <a href="array.sorting.html" class="link">comparison of array sorting functions</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.krsort.html">krsort</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.list.html">list</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>