WP_REST_Users_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_Users_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_user_by().

Scaling

Constant

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

Instructions

13–76

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

Plugin surface

1 hook

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

Called by

1

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

What it touches

• hookthird-party callbacksdo_action()called directly
• querycontent queryget_user_by()one call below WP_REST_Users_Controller::delete_item()

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

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

1. 1
   do_action( rest_delete_user )actionline 961 (+74 into the body)

   Fires immediately after a user is deleted via the REST API.

Uses · 11

• is_multisite()Determines whether Multisite is enabled.
• __()Retrieves the translation of $text.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• absint()Converts a value to non-negative integer.
• get_userdata()Retrieves user info by user ID.
• wp_delete_user()Delete user and optionally reassign posts and links to another user.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_Error::__construct()Initializes the error.
• WP_REST_Users_Controller::get_user()Get the user, if the ID is valid.
• WP_REST_Users_Controller::prepare_item_for_response()Prepares a single user output for response.
• WP_REST_Response::__construct()

Used by · 1

• WP_REST_Users_Controller::delete_current_item()Deletes the current user.

Source code

View on Trac ↗View on GitHub ↗

887	public function delete_item( $request ) {888		// We don't support delete requests in multisite.889		if ( is_multisite() ) {890			return new WP_Error(891				'rest_cannot_delete',892				__( 'The user cannot be deleted.' ),893				array( 'status' => 501 )894			);895		}896 897		$user = $this->get_user( $request['id'] );898 899		if ( is_wp_error( $user ) ) {900			return $user;901		}902 903		$id       = $user->ID;904		$reassign = false === $request['reassign'] ? null : absint( $request['reassign'] );905		$force    = isset( $request['force'] ) ? (bool) $request['force'] : false;906 907		// We don't support trashing for users.908		if ( ! $force ) {909			return new WP_Error(910				'rest_trash_not_supported',911				/* translators: %s: force=true */912				sprintf( __( "Users do not support trashing. Set '%s' to delete." ), 'force=true' ),913				array( 'status' => 501 )914			);915		}916 917		if ( ! empty( $reassign ) ) {918			if ( $reassign === $id || ! get_userdata( $reassign ) ) {919				return new WP_Error(920					'rest_user_invalid_reassign',921					__( 'Invalid user ID for reassignment.' ),922					array( 'status' => 400 )923				);924			}925		}926 927		$request->set_param( 'context', 'edit' );928 929		$previous = $this->prepare_item_for_response( $user, $request );930 931		// Include user admin functions to get access to wp_delete_user().932		require_once ABSPATH . 'wp-admin/includes/user.php';933 934		$result = wp_delete_user( $id, $reassign );935 936		if ( ! $result ) {937			return new WP_Error(938				'rest_cannot_delete',939				__( 'The user cannot be deleted.' ),940				array( 'status' => 500 )941			);942		}943 944		$response = new WP_REST_Response();945		$response->set_data(946			array(947				'deleted'  => true,948				'previous' => $previous->get_data(),949			)950		);951 952		/**953		 * Fires immediately after a user is deleted via the REST API.954		 *955		 * @since 4.7.0956		 *957		 * @param WP_User          $user     The user data.958		 * @param WP_REST_Response $response The response returned from the API.959		 * @param WP_REST_Request  $request  The request sent to the API.960		 */961		do_action( 'rest_delete_user', $user, $response, $request );962 963		return $response;964	}

Changelog

Introduced in 4.7.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-users-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.