(PHP 4, PHP 5, PHP 7, PHP 8)
ksort — Sort an array by key
&$array
, int $flags
= SORT_REGULAR
) : boolSorts an array by key, maintaining key to data correlations. This is useful mainly for associative arrays.
array
The input array.
flags
The optional second parameter flags
may be used to modify the sorting behavior using these values:
Sorting type flags:
SORT_REGULAR
- compare items normally;
the details are described in the comparison operators section
SORT_NUMERIC
- compare items numerically
SORT_STRING
- compare items as strings
SORT_LOCALE_STRING
- compare items as
strings, based on the current locale. It uses the locale,
which can be changed using setlocale()
SORT_NATURAL
- compare items as strings
using "natural ordering" like natsort()
SORT_FLAG_CASE
- can be combined
(bitwise OR) with
SORT_STRING
or
SORT_NATURAL
to sort strings case-insensitively
Returns true
on success or false
on failure.
Example #1 ksort() example
<?php
$fruits = array("d"=>"lemon", "a"=>"orange", "b"=>"banana", "c"=>"apple");
ksort($fruits);
foreach ($fruits as $key => $val) {
echo "$key = $val\n";
}
?>
The above example will output:
a = orange b = banana c = apple d = lemon