WP_REST_Menus_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

Response object on success, or WP_Error object on failure.

Performance profile

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

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

12–50

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

Plugin surface

1 hook

Third-party callbacks on 'rest_delete_{$this->taxonomy}' 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

• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach query, cache, option, 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 · 5 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Menus_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_Menus_Controller::delete_item() runs, in this order:

1. 1
   do_action( rest_delete_{$this->taxonomy} )actionline 404 (+31 into the body)

   Fires after a single term is deleted via the REST API.

Uses · 8

• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• wp_delete_nav_menu()Deletes a navigation menu.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_REST_Menus_Controller::get_term()Gets the term, if the ID is valid.
• WP_Error::__construct()Initializes the error.
• WP_REST_Menus_Controller::prepare_item_for_response()Prepares a single term output for response.
• WP_REST_Response::__construct()

Source code

View on Trac ↗View on GitHub ↗

373	public function delete_item( $request ) {374		$term = $this->get_term( $request['id'] );375		if ( is_wp_error( $term ) ) {376			return $term;377		}378 379		// We don't support trashing for terms.380		if ( ! $request['force'] ) {381			/* translators: %s: force=true */382			return new WP_Error( 'rest_trash_not_supported', sprintf( __( "Menus do not support trashing. Set '%s' to delete." ), 'force=true' ), array( 'status' => 501 ) );383		}384 385		$request->set_param( 'context', 'view' );386 387		$previous = $this->prepare_item_for_response( $term, $request );388 389		$result = wp_delete_nav_menu( $term );390 391		if ( ! $result || is_wp_error( $result ) ) {392			return new WP_Error( 'rest_cannot_delete', __( 'The menu cannot be deleted.' ), array( 'status' => 500 ) );393		}394 395		$response = new WP_REST_Response();396		$response->set_data(397			array(398				'deleted'  => true,399				'previous' => $previous->get_data(),400			)401		);402 403		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php */404		do_action( "rest_delete_{$this->taxonomy}", $term, $response, $request );405 406		return $response;407	}

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.0.4 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-menus-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.