WP_REST_Menu_Items_Controller::delete_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

True on success, or WP_Error object on failure.

Performance profile

How much work a call to WP_REST_Menu_Items_Controller::delete_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–48

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

Plugin surface

1 hook

Third-party callbacks on 'rest_delete_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 cache, transient, serialize and option. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 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::delete_item() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_REST_Menu_Items_Controller::delete_item() runs, in this order:

1. 1
   do_action( rest_delete_nav_menu_item )actionline 314 (+37 into the body)

   Fires immediately after a single menu item is deleted via the REST API.

Uses · 9

• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• get_post()Retrieves post data given a post ID or post object.
• wp_delete_post()Trashes or deletes a post or page.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_REST_Menu_Items_Controller::get_nav_menu_item()Gets the nav menu item, if the ID is valid.
• WP_Error::__construct()Initializes the error.
• WP_REST_Menu_Items_Controller::prepare_item_for_response()Prepares a single nav menu item output for response.
• WP_REST_Response::__construct()

Source code

View on Trac ↗View on GitHub ↗

277	public function delete_item( $request ) {278		$menu_item = $this->get_nav_menu_item( $request['id'] );279		if ( is_wp_error( $menu_item ) ) {280			return $menu_item;281		}282 283		// We don't support trashing for menu items.284		if ( ! $request['force'] ) {285			/* translators: %s: force=true */286			return new WP_Error( 'rest_trash_not_supported', sprintf( __( "Menu items do not support trashing. Set '%s' to delete." ), 'force=true' ), array( 'status' => 501 ) );287		}288 289		$previous = $this->prepare_item_for_response( get_post( $request['id'] ), $request );290 291		$result = wp_delete_post( $request['id'], true );292 293		if ( ! $result ) {294			return new WP_Error( 'rest_cannot_delete', __( 'The post cannot be deleted.' ), array( 'status' => 500 ) );295		}296 297		$response = new WP_REST_Response();298		$response->set_data(299			array(300				'deleted'  => true,301				'previous' => $previous->get_data(),302			)303		);304 305		/**306		 * Fires immediately after a single menu item is deleted via the REST API.307		 *308		 * @since 5.9.0309		 *310		 * @param object          $nav_menu_item Inserted or updated menu item object.311		 * @param WP_REST_Response $response The response data.312		 * @param WP_REST_Request $request       Request object.313		 */314		do_action( 'rest_delete_nav_menu_item', $menu_item, $response, $request );315 316		return $response;317	}

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