wp_update_nav_menu_item( int $menu_id = 0, int $menu_item_db_id = 0, array $menu_item_data = array(), bool $fire_after_hooks = true ): int|WP_Error

Description

Compatibility

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

Parameters

$menu_idintoptional

The ID of the menu. If 0, makes the menu item a draft orphan.Default: 0

$menu_item_db_idintoptional

The ID of the menu item. If 0, creates a new menu item.Default: 0

$menu_item_dataarrayoptional

The menu item's data.Default: array()

$fire_after_hooksbooloptional

Whether to fire the after insert hooks. Default true.Default: true

Return value

int|WP_Error

The menu item's database ID or WP_Error object on failure.

Performance profile

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

Heavy

Reaches the database via get_term().

Scaling

Constant

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

Instructions

115–292

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

Plugin surface

2 hooks

Third-party callbacks on 'wp_add_nav_menu_item', 'wp_update_nav_menu_item' run inside this call, and their cost is not bounded by anything here.

Called by

6

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

What it touches

• querycontent queryget_term()called directly
• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()one call below wp_update_nav_menu_item()
• cacheobject cachewp_cache_set()one call below wp_update_nav_menu_item()

Further down the call graph this can also reach 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 · 78 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 2

2 hooks fire while wp_update_nav_menu_item() runs, in this order:

1. 1
   do_action( wp_add_nav_menu_item )actionline 562 (+144 into the body)

   Fires immediately after a new navigation menu item has been added.

2. 2
   do_action( wp_update_nav_menu_item )actionline 628 (+210 into the body)

   Fires after a navigation menu item has been updated.

Uses · 24

• is_nav_menu_item()Determines whether the given ID is a nav menu item.
• __()Retrieves the translation of $text.
• wp_get_nav_menu_object()Returns a navigation menu object.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_parse_args()Merges user defined arguments into defaults array.
• wp_get_nav_menu_items()Retrieves all menu items of a navigation menu.
• get_post_field()Retrieves data from a post field based on Post ID.
• get_term()Gets all term data from database by term ID.
• get_term_field()Gets sanitized term field.
• get_post()Retrieves post data given a post ID or post object.
• get_post_type_object()Retrieves a post type object by name.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.

Used by · 6

• WP_Customize_Nav_Menu_Item_Setting::update()Creates/updates the nav_menu_item post for this setting.
• WP_REST_Menu_Items_Controller::create_item()Creates a single nav menu item.
• WP_REST_Menu_Items_Controller::update_item()Updates a single nav menu item.
• _wp_auto_add_pages_to_menu()Automatically add newly published page objects to menus with that as an option.
• wp_nav_menu_update_menu_items()Saves nav menu items.
• wp_save_nav_menu_items()Save posted nav menu item data.

Source code

View on Trac ↗View on GitHub ↗

418function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item_data = array(), $fire_after_hooks = true ) {419	$menu_id         = (int) $menu_id;420	$menu_item_db_id = (int) $menu_item_db_id;421 422	// Make sure that we don't convert non-nav_menu_item objects into nav_menu_item objects.423	if ( ! empty( $menu_item_db_id ) && ! is_nav_menu_item( $menu_item_db_id ) ) {424		return new WP_Error( 'update_nav_menu_item_failed', __( 'The given object ID is not that of a menu item.' ) );425	}426 427	$menu = wp_get_nav_menu_object( $menu_id );428 429	if ( ! $menu && 0 !== $menu_id ) {430		return new WP_Error( 'invalid_menu_id', __( 'Invalid menu ID.' ) );431	}432 433	if ( is_wp_error( $menu ) ) {434		return $menu;435	}436 437	$defaults = array(438		'menu-item-db-id'         => $menu_item_db_id,439		'menu-item-object-id'     => 0,440		'menu-item-object'        => '',441		'menu-item-parent-id'     => 0,442		'menu-item-position'      => 0,443		'menu-item-type'          => 'custom',444		'menu-item-title'         => '',445		'menu-item-url'           => '',446		'menu-item-description'   => '',447		'menu-item-attr-title'    => '',448		'menu-item-target'        => '',449		'menu-item-classes'       => '',450		'menu-item-xfn'           => '',451		'menu-item-status'        => '',452		'menu-item-post-date'     => '',453		'menu-item-post-date-gmt' => '',454	);455 456	$args = wp_parse_args( $menu_item_data, $defaults );457 458	if ( 0 === $menu_id ) {459		$args['menu-item-position'] = 1;460	} elseif ( 0 === (int) $args['menu-item-position'] ) {461		$menu_items = array();462 463		if ( 0 !== $menu_id ) {464			$menu_items = (array) wp_get_nav_menu_items( $menu_id, array( 'post_status' => 'publish,draft' ) );465		}466 467		$last_item = array_pop( $menu_items );468 469		if ( $last_item && isset( $last_item->menu_order ) ) {470			$args['menu-item-position'] = 1 + $last_item->menu_order;471		} else {472			$args['menu-item-position'] = count( $menu_items );473		}474	}475 476	$original_parent = 0 < $menu_item_db_id ? get_post_field( 'post_parent', $menu_item_db_id ) : 0;477 478	if ( 'custom' === $args['menu-item-type'] ) {479		// If custom menu item, trim the URL.480		$args['menu-item-url'] = trim( $args['menu-item-url'] );481	} else {482		/*483		 * If non-custom menu item, then:484		 * - use the original object's URL.485		 * - blank default title to sync with the original object's title.486		 */487 488		$args['menu-item-url'] = '';489 490		$original_title = '';491 492		if ( 'taxonomy' === $args['menu-item-type'] ) {493			$original_object = get_term( $args['menu-item-object-id'], $args['menu-item-object'] );494 495			if ( $original_object instanceof WP_Term ) {496				$original_parent = get_term_field( 'parent', $args['menu-item-object-id'], $args['menu-item-object'], 'raw' );497				$original_title  = get_term_field( 'name', $args['menu-item-object-id'], $args['menu-item-object'], 'raw' );

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 7.1.0 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.