wppaste
WordPress

_sort_nav_menu_items( object $a, object $b ): int

Since
3.0.0
Source
wp-includes/deprecated.php:3912
Sort menu items by the desired key.

Compatibility

Deprecated in WordPress 4.7.0. Use wp_list_sort()

WordPress
since 3.0.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$aobject
The first object to compare
$bobject
The second object to compare

Return value

int
-1, 0, or 1 if $a is considered to be respectively less than, equal to, or greater than $b.

Performance profile

How much work a call to _sort_nav_menu_items() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
11–35

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

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 it touches

  • hookthird-party callbacksdo_action()one call below _sort_nav_menu_items()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always11–31_deprecated_function()
!empty($_menu_item_sort_prop) && isset($a->_menu_item_sort_prop) && isset($b->_menu_item_sort_prop)32–35_deprecated_function(), strcmp()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 42 instructions, 11–35 executed per call, 7 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Source code

function _sort_nav_menu_items( $a, $b ) {	global $_menu_item_sort_prop; 	_deprecated_function( __FUNCTION__, '4.7.0', 'wp_list_sort()' ); 	if ( empty( $_menu_item_sort_prop ) )		return 0; 	if ( ! isset( $a->$_menu_item_sort_prop ) || ! isset( $b->$_menu_item_sort_prop ) )		return 0; 	$_a = (int) $a->$_menu_item_sort_prop;	$_b = (int) $b->$_menu_item_sort_prop; 	if ( $a->$_menu_item_sort_prop == $b->$_menu_item_sort_prop )		return 0;	elseif ( $_a == $a->$_menu_item_sort_prop && $_b == $b->$_menu_item_sort_prop )		return $_a < $_b ? -1 : 1;	else		return strcmp( $a->$_menu_item_sort_prop, $b->$_menu_item_sort_prop );}

Changelog

Introduced in 3.0.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.

4.7.0
Deprecated. Use wp_list_sort()from the docblock
3.0.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/deprecated.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.