Home > PHP > Function > Arrays > uksort()

uksort()

uksort - Sort an array by keys using a user-defined comparison function

Syntax

bool uksort (array &$array, callback $cmp_function)

Arguments

  • array - The input array.
  • cmp_function - The callback comparison function. Function cmp_function should accept two parameters which will be filled by pairs of array keys. The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.

Description

uksort() will sort the keys of an array using a user-supplied comparison function. If the array you wish to sort needs to be sorted by some non-trivial criteria, you should use this function.

Version

PHP 4, 5

Return value

Returns TRUE on success or FALSE on failure.