WP_List_Util::sort( string|array $orderby = array(), string $order = 'ASC', bool $preserve_keys = false ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$orderbystring|arrayoptional

Either the field name to order by or an array of multiple orderby fields as $orderby => $order.
Default empty array.Default: array()

$orderstringoptional

Either 'ASC' or 'DESC'. Only used if $orderby is a string. Default 'ASC'.Default: 'ASC'

$preserve_keysbooloptional

Whether to preserve keys. Default false.Default: false

Return value

array

The sorted array.

Performance profile

How much work a call to WP_List_Util::sort() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

7–28

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 50.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_List_Util::sort() can have, taken from its control-flow graph on PHP 8.5.

Source code

View on Trac ↗View on GitHub ↗

229	public function sort( $orderby = array(), $order = 'ASC', $preserve_keys = false ) {230		if ( empty( $orderby ) ) {231			return $this->output;232		}233 234		if ( is_string( $orderby ) ) {235			$orderby = array( $orderby => $order );236		}237 238		foreach ( $orderby as $field => $direction ) {239			$orderby[ $field ] = 'DESC' === strtoupper( $direction ) ? 'DESC' : 'ASC';240		}241 242		$this->orderby = $orderby;243 244		if ( $preserve_keys ) {245			uasort( $this->output, array( $this, 'sort_callback' ) );246		} else {247			usort( $this->output, array( $this, 'sort_callback' ) );248		}249 250		$this->orderby = array();251 252		return $this->output;253	}

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-list-util.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.