array_multisort

Function • Return type changed in PHP 8.5

Sort multiple or multi-dimensional arrays.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1-8.2
PHP 8.3
PHP 8.4
PHP 8.5
Improved
PHP 8.6

array_multisort Function synopsis

array_multisort(&$array, ...&$rest): true

Parameters

$array

Passed by reference

An array being sorted.

$rest

Variadic, Passed by reference, Optional

More arrays, optionally followed by sort order and flags. Only elements corresponding to equivalent elements in previous arrays are compared. In other words, the sort is lexicographical.

Note that the parameters $array and $rest are passed by reference, and contain additional/updated context data that may be useful.

Return value

Typetrue

Returns true on success, false on failure

Changes to the array_multisort Function

PHP 8.5

  • Return type changed: bool to true
- array_multisort(&$array, ...&$rest): bool
+ array_multisort(&$array, ...&$rest): true

PHP 8.0

  • Return type added: bool
  • Parameter count changed: 4 to 2
  • Optional parameter removed - #3: &$sort_flags
  • Optional parameter removed - #4: &$arr2
-array_multisort(
-    &$arr1,
-    &$sort_order,
-    &$sort_flags,
-    ...&$arr2
-  )
+array_multisort(&$array, ...&$rest): bool

array_multisort Function Availability

PHP VersionAvailability
PHP 8.6Future Release Yes
PHP 8.5Upcoming Release Yes
PHP 8.4Supported (Latest) Yes
PHP 8.3Supported Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Security-Fixes Only Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes