Home > PHP > Function > Arrays > usort()

usort()

usort - Sort an array by values using a user-defined comparison function

Syntax

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

Arguments

  • array - The input array.
  • cmp_function - 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

This function will sort an array by its values 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.