wp_get_associated_nav_menu_items( int $object_id = 0, string $object_type = 'post_type', string $taxonomy = '' ): int[]

Compatibility

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

Parameters

$object_idintoptional

The ID of the original object. Default 0.Default: 0

$object_typestringoptional

The type of object, such as 'post_type' or 'taxonomy'.
Default 'post_type'.Default: 'post_type'

$taxonomystringoptional

If $object_type is 'taxonomy', $taxonomy is the name of the tax that $object_id belongs to. Default empty.Default: ''

Return value

int[]

The array of menu item IDs; empty array if none.

Performance profile

How much work a call to wp_get_associated_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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

25–26

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

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_get_associated_nav_menu_items() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• is_nav_menu_item()Determines whether the given ID is a nav menu item.
• get_post_meta()Retrieves a post meta field for the given post ID.
• WP_Query::__construct()Constructor.

Used by · 2

• _wp_delete_post_menu_item()Callback for handling a menu item when its original object is deleted.
• _wp_delete_tax_menu_item()Serves as a callback for handling a menu item when its original object is deleted.

Source code

View on Trac ↗View on GitHub ↗

1055function wp_get_associated_nav_menu_items( $object_id = 0, $object_type = 'post_type', $taxonomy = '' ) {1056	$object_id     = (int) $object_id;1057	$menu_item_ids = array();1058 1059	$query      = new WP_Query();1060	$menu_items = $query->query(1061		array(1062			'meta_key'       => '_menu_item_object_id',1063			'meta_value'     => $object_id,1064			'post_status'    => 'any',1065			'post_type'      => 'nav_menu_item',1066			'posts_per_page' => -1,1067		)1068	);1069	foreach ( (array) $menu_items as $menu_item ) {1070		if ( isset( $menu_item->ID ) && is_nav_menu_item( $menu_item->ID ) ) {1071			$menu_item_type = get_post_meta( $menu_item->ID, '_menu_item_type', true );1072			if (1073				'post_type' === $object_type &&1074				'post_type' === $menu_item_type1075			) {1076				$menu_item_ids[] = (int) $menu_item->ID;1077			} elseif (1078				'taxonomy' === $object_type &&1079				'taxonomy' === $menu_item_type &&1080				get_post_meta( $menu_item->ID, '_menu_item_object', true ) === $taxonomy1081			) {1082				$menu_item_ids[] = (int) $menu_item->ID;1083			}1084		}1085	}1086 1087	return array_unique( $menu_item_ids );1088}

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.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/nav-menu.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.