WP_REST_Menu_Items_Controller::update_item( WP_REST_Request $request ): WP_REST_Response|WP_Error

Compatibility

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

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response|WP_Error

Response object on success, or WP_Error object on failure.

Performance profile

How much work a call to WP_REST_Menu_Items_Controller::update_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_post().

Scaling

Constant

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

Instructions

12–125

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

Plugin surface

2 hooks

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

Called by

0

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

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksdo_action()called directly

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

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

Hooks and filters fired · 2

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

1. 1
   do_action( rest_insert_nav_menu_item )actionline 252 (+34 into the body)

   Fires after a single menu item is created or updated via the REST API.

2. 2
   do_action( rest_after_insert_nav_menu_item )actionline 275 (+57 into the body)

   Fires after a single menu item is completely created or updated via the REST API.

Uses · 12

• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_post()Retrieves post data given a post ID or post object.
• wp_update_nav_menu_item()Saves the properties of a menu item or create a new one.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_after_insert_post()Fires actions after a post, its terms and meta data has been saved.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Menu_Items_Controller::get_nav_menu_item()Gets the nav menu item, if the ID is valid.
• WP_REST_Menu_Items_Controller::prepare_item_for_database()Prepares a single nav menu item for create or update.
• WP_REST_Menu_Items_Controller::get_item_schema()Retrieves the nav menu item's schema, conforming to JSON Schema.
• WP_REST_Menu_Items_Controller::update_additional_fields_for_object()
• WP_REST_Menu_Items_Controller::prepare_item_for_response()Prepares a single nav menu item output for response.

Source code

View on Trac ↗View on GitHub ↗

218	public function update_item( $request ) {219		$valid_check = $this->get_nav_menu_item( $request['id'] );220		if ( is_wp_error( $valid_check ) ) {221			return $valid_check;222		}223		$post_before       = get_post( $request['id'] );224		$prepared_nav_item = $this->prepare_item_for_database( $request );225 226		if ( is_wp_error( $prepared_nav_item ) ) {227			return $prepared_nav_item;228		}229 230		$prepared_nav_item = (array) $prepared_nav_item;231 232		$nav_menu_item_id = wp_update_nav_menu_item( $prepared_nav_item['menu-id'], $prepared_nav_item['menu-item-db-id'], wp_slash( $prepared_nav_item ), false );233 234		if ( is_wp_error( $nav_menu_item_id ) ) {235			if ( 'db_update_error' === $nav_menu_item_id->get_error_code() ) {236				$nav_menu_item_id->add_data( array( 'status' => 500 ) );237			} else {238				$nav_menu_item_id->add_data( array( 'status' => 400 ) );239			}240 241			return $nav_menu_item_id;242		}243 244		$nav_menu_item = $this->get_nav_menu_item( $nav_menu_item_id );245		if ( is_wp_error( $nav_menu_item ) ) {246			$nav_menu_item->add_data( array( 'status' => 404 ) );247 248			return $nav_menu_item;249		}250 251		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php */252		do_action( 'rest_insert_nav_menu_item', $nav_menu_item, $request, false );253 254		$schema = $this->get_item_schema();255 256		if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {257			$meta_update = $this->meta->update_value( $request['meta'], $nav_menu_item->ID );258 259			if ( is_wp_error( $meta_update ) ) {260				return $meta_update;261			}262		}263 264		$post          = get_post( $nav_menu_item_id );265		$nav_menu_item = $this->get_nav_menu_item( $nav_menu_item_id );266		$fields_update = $this->update_additional_fields_for_object( $nav_menu_item, $request );267 268		if ( is_wp_error( $fields_update ) ) {269			return $fields_update;270		}271 272		$request->set_param( 'context', 'edit' );273 274		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php */275		do_action( 'rest_after_insert_nav_menu_item', $nav_menu_item, $request, false );276 277		wp_after_insert_post( $post, true, $post_before );278 279		$response = $this->prepare_item_for_response( get_post( $nav_menu_item_id ), $request );280 281		return rest_ensure_response( $response );282	}

Changelog

Introduced in 5.9.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/rest-api/endpoints/class-wp-rest-menu-items-controller.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.