PHP | uksort() Function

Hello folks! welcome back to a new edition of our tutorial on PHP. In this tutorial guide, we are going to be studying about the PHP uksort() Function.

The built-in PHP uksort() function sorts an array by element keys making use of user-defined comparison function.

Syntax

Following below is the syntax to use this function -

uksort ( $array, $cmp_function )

READ: PHP | sort() Function

Parameter Details

Sr.No	Parameter & Description
1	array(Required) It specifies an array.
2	cmp_function(Required) Use if defined function to compare values and to sort them. The function must return -1, 0, or 1 for this method to work correctly. It should be written to accept two parameters to compare, and it should work something like this − If a = b, return 0 If a > b, return 1 If a < b, return -1

Return Value

This function returns TRUE on success, or FALSE on failure.

Example

Try out the below example -

<?php
   function cmp_function($a, $b) {
      if ($a == $b) return 0;
      return ($a > $b) ? -1 : 1;
   }
   
   $input = array("d"=>"lemon", "a"=>"orange", "b"=>"banana" );
   uksort($input, "cmp_function");
   
   print_r($input);
?> 

Output

When the above code is executed, it will produce the following result -

Array ( [d] => lemon [b] => banana [a] => orange )

READ: PHP | uasort() Function

Alright guys! This is where we are going to be rounding up for this tutorial post. In our next tutorial, we are going to be discussing about the PHP usort() Function.

Feel free to ask your questions where necessary and we will attend to them as soon as possible. If this tutorial was helpful to you, you can use the share button to share this tutorial.

Follow us on our various social media platforms to stay updated with our latest tutorials. You can also subscribe to our newsletter in order to get our tutorials delivered directly to your emails.

Thanks for reading and bye for now.