W3cubDocs

/WordPress

wp_list_sort( array $list, string|array $orderby = array(), string $order = 'ASC', bool $preserve_keys = false )

Sorts a list of objects, based on one or more orderby arguments.

Parameters

$list

(array) (Required) An array of objects to sort.

$orderby

(string|array) (Optional) Either the field name to order by or an array of multiple orderby fields as $orderby => $order.

Default value: array()

$order

(string) (Optional) Either 'ASC' or 'DESC'. Only used if $orderby is a string.

Default value: 'ASC'

$preserve_keys

(bool) (Optional) Whether to preserve keys.

Default value: false

Return

(array) The sorted array.

Source

File: wp-includes/functions.php 

function wp_list_sort( $list, $orderby = array(), $order = 'ASC', $preserve_keys = false ) {
	if ( ! is_array( $list ) ) {
		return array();
	}

	$util = new WP_List_Util( $list );
	return $util->sort( $orderby, $order, $preserve_keys );
}

Used By

Used By Description
wp-includes/customize/class-wp-customize-nav-menu-setting.php: WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()

Filters the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.
wp-includes/customize/class-wp-customize-nav-menu-item-setting.php: WP_Customize_Nav_Menu_Item_Setting::sort_wp_get_nav_menu_items()

Re-apply the tail logic also applied on $items by wp_get_nav_menu_items().
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::prepare_controls()

Prepare panels, sections, and controls.
wp-includes/link-template.php: get_permalink()

Retrieves the full permalink for the current post or post ID.
wp-includes/nav-menu.php: wp_get_nav_menu_items()

Retrieves all menu items of a navigation menu.

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_list_sort