Function to sort an array and return the sorted array

Question

PHP's native sorting functions modify by reference and do not return the sorted array.

I am looking for a reliable standard method to sort an array, returning the sorted array as the return value.

All of the PHP.net functions I have read about return BOOLEAN value, or 0-1.

The method I need would be something like:

$some_mixed_array = array( 998, 6, 430 );
function custom_sort( $array )
{ 
  // Sort it
  // return sorted array
}

custom_sort( $some_mixed_array );

// returning: array( 6, 430, 998 )

No need to handle strings, just INT-s.

Why not sort a copy of the array using PHP functions and return the result? — Aneri
– Aneri, Commented Sep 10, 2013 at 13:47
Can the original array be modified or should it be left as is? If not, function custom_sort($a) { sort($a); return $a; } — knittl
– knittl, Commented Sep 10, 2013 at 13:47
do you mean 'short' or 'sort'? In your code you have short — Jakub
– Jakub, Commented Sep 10, 2013 at 13:47
While the sort functions return a bool they still sort your array - so what problem are you trying to solve ? — Eike Pierstorff
– Eike Pierstorff, Commented Sep 10, 2013 at 13:47
Why so many downvotes?! It seems like an excellent question, that has a nice clear answer. As a reason to want this, you have one-liners like: assert(sort(array_keys($myData)) == array('x','y')) This fails with "Only variables should be passed by reference". — Darren Cook
– Darren Cook, Commented Jan 22, 2014 at 1:31

Ben · Accepted Answer · 2018-05-03 15:39:07Z

13

Here's a one-liner:

call_user_func(function(array $a){asort($a);return $a;}, $some_mixed_array);

answered May 3, 2018 at 15:39

Ben

9559 silver badges14 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

nbro Dec 24, 2024 at 19:34

Why is a one-liner a good thing? This only makes readability a bit harder, in my view. Also, it would be great to explain why this works. I know why it works but you could have explained it. For example, why don't we need to use say clone? Many people will just copy and paste this code and will not even understand it.

MonkeyZeus · Accepted Answer · 2013-09-10 13:52:42Z

5

Would you be able to do this?

$some_mixed_array = array( 998, 6, 430 );
function custom_sort( $array )
{
  // Sort it
  asort($array);

  // return sorted array
  return $array;
}

custom_sort( $some_mixed_array );

// returning: array( 6, 430, 998 )

This would also solve your issue:

$some_mixed_array = array( 998, 6, 430 );
echo '<pre>'.print_r($some_mixed_array, true).'</pre>';

asort($some_mixed_array); // <- BAM!

// returning: array( 6, 430, 998 )
echo '<pre>'.print_r($some_mixed_array, true).'</pre>';

answered Sep 10, 2013 at 13:52

MonkeyZeus

20.8k4 gold badges41 silver badges83 bronze badges

2 Comments

Robo Robok Over a year ago

You should warn that these two solutions do two different things. The first one doesn't change the original array, while the second does. Plus, using asort on number-indexed array is pretty weird. You maintain the original keys, but you are unable to iterate it naturally. It loses its nature of pure array.

Jonathan Over a year ago

sorted is the name of the function python uses

Stephen R · Accepted Answer · 2023-01-30 17:35:44Z

4

As others have said, your best bet is to create a custom function. However, in order to maintain flexibility with the future of PHP, I would use a variadic function. Essentially, you set your function to accepts whatever parameters are passed to it, and pass them through to the actual sort() function. Done this way, you can use whatever optional parameters exist for the standard function you're putting the wrapper around -- even if those parameters change in the future.

function mysort( ...$params ) {
    sort( ...$params );
    return $params[0];
}

UPDATE: Same functionality, but somewhat easier to understand:

function mysort( $array, ...$params ) {
    sort( $array, ...$params );
    return $array;
}

edited Jan 30, 2023 at 17:35

answered Oct 3, 2019 at 19:17

Stephen R

3,9351 gold badge31 silver badges54 bronze badges

Comments

mickmackusa · Accepted Answer · 2023-12-08 06:51:44Z

1

From PHP7, you can feed your input array to an IIFE if you like one-liners. This will not mutate the original array, but return the mutated version of a copy of the original.

Code: (Demo)

$some_mixed_array = [998, 6, 430];

var_export(
    (function($v) { sort($v); return $v; })($some_mixed_array)
);

(function($v) { sort($v); return $v; }) is the closure.
($some_mixed_array) is the single parameter inside the function signature.

sort() will not preserve the array's keys after sorting.
asort() will preserve the array's keys after sorting.

Of if you prefer brevity and don't mind using a ternary condition, you can enjoy PHP's arrow function syntax. (Demo)

var_export(
    (fn($v) => sort($v) ? $v : $v)($some_mixed_array)
);

edited Dec 8, 2023 at 6:51

answered Jan 30, 2023 at 22:22

mickmackusa♦

49.2k13 gold badges98 silver badges165 bronze badges

Collectives™ on Stack Overflow

Function to sort an array and return the sorted array

4 Answers 4

1 Comment

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related