wp_list_sort( array $input_list, string|array $orderby = array(), string $order = 'ASC', bool $preserve_keys = false ): array
Sorts an array of objects or arrays based on one or more orderby arguments.
Parameters
-
$input_list
array Required -
An array of objects or arrays to sort.
-
$orderby
string|array Optional -
Either the field name to order by or an array of multiple orderby fields as
$orderby => $order
.
Default:
array()
-
$order
string Optional -
Either
'ASC'
or'DESC'
. Only used if$orderby
is a string. Default'ASC'
.Default:
'ASC'
-
$preserve_keys
bool Optional -
Whether to preserve keys.
Default:
false
Return
array The sorted array.
Source
File: wp-includes/functions.php
.
View all references
function wp_list_sort( $input_list, $orderby = array(), $order = 'ASC', $preserve_keys = false ) {
if ( ! is_array( $input_list ) ) {
return array();
}
$util = new WP_List_Util( $input_list );
return $util->sort( $orderby, $order, $preserve_keys );
}
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example of usage: