WP_REST_Users_Controller::delete_item PHP Method

delete_item() public method

Deletes a single user.
Since: 4.7.0
public delete_item ( WP_REST_Request $request ) : WP_REST_Response | WP_Error
$request WP_REST_Request Full details about the request.
return WP_REST_Response | WP_Error Response object on success, or WP_Error object on failure.
    public function delete_item($request)
    {
        $id = (int) $request['id'];
        $reassign = isset($request['reassign']) ? absint($request['reassign']) : null;
        $force = isset($request['force']) ? (bool) $request['force'] : false;
        // We don't support trashing for users.
        if (!$force) {
            return new WP_Error('rest_trash_not_supported', __('Users do not support trashing. Set force=true to delete.'), array('status' => 501));
        }
        $user = get_userdata($id);
        if (!$user) {
            return new WP_Error('rest_user_invalid_id', __('Invalid user ID.'), array('status' => 404));
        }
        if (!empty($reassign)) {
            if ($reassign === $id || !get_userdata($reassign)) {
                return new WP_Error('rest_user_invalid_reassign', __('Invalid user ID for reassignment.'), array('status' => 400));
            }
        }
        $request->set_param('context', 'edit');
        $previous = $this->prepare_item_for_response($user, $request);
        /** Include admin user functions to get access to wp_delete_user() */
        require_once ABSPATH . 'wp-admin/includes/user.php';
        $result = wp_delete_user($id, $reassign);
        if (!$result) {
            return new WP_Error('rest_cannot_delete', __('The user cannot be deleted.'), array('status' => 500));
        }
        $response = new WP_REST_Response();
        $response->set_data(array('deleted' => true, 'previous' => $previous->get_data()));
        /**
         * Fires immediately after a user is deleted via the REST API.
         *
         * @since 4.7.0
         *
         * @param WP_User          $user     The user data.
         * @param WP_REST_Response $response The response returned from the API.
         * @param WP_REST_Request  $request  The request sent to the API.
         */
        do_action('rest_delete_user', $user, $response, $request);
        return $response;
    }