ksort
(PHP 4, PHP 5, PHP 7)
ksort — Sort an array by key
Description
ksort ( array &$array [, int $flags = SORT_REGULAR ] ) : bool
Sorts an array by key, maintaining key to data correlations. This is useful mainly for associative arrays.
Parameters
-
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) withSORT_STRING
orSORT_NATURAL
to sort strings case-insensitively
-
Return Values
Returns true
on success or false
on failure.
Examples
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
See Also
- asort() - Sort an array and maintain index association
- The comparison of array sorting functions
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.ksort.php