BP_REST_Members_Endpoint::delete_item_permissions_check( WP_REST_Request $request )

Check if a given request has access to delete a member.

Description

Parameters

$request: (Required) Full details about the request.

Return

(bool|WP_Error)

Source

File: bp-members/classes/class-bp-rest-members-endpoint.php

public function delete_item_permissions_check( $request ) {
    $retval = true;
 
    if ( ! is_user_logged_in() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you need to be logged in to perform this action.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    $user_id = (int) $request['id'];
    if ( empty( $user_id ) ) {
        $user_id = bp_loggedin_user_id();
    }
 
    if ( true === $retval && bp_loggedin_user_id() !== absint( $user_id ) && ! bp_current_user_can( 'delete_users' ) ) {
        $retval = new WP_Error(
            'bp_rest_user_cannot_delete',
            __( 'Sorry, you are not allowed to delete this user.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    if ( true === $retval && function_exists( 'bp_disable_account_deletion' ) && bp_disable_account_deletion() ) {
        $retval = new WP_Error(
            'bp_rest_user_cannot_delete',
            __( 'Sorry, you are not allowed to delete this user.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the members `delete_item` permissions check.
     *
     * @param bool|WP_Error $retval Returned value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_members_delete_item_permissions_check', $retval, $request );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
0.1.0	Introduced.

Uses

Uses
Uses	Description
bp-members/classes/class-bp-rest-members-endpoint.php: bp_rest_members_delete_item_permissions_check	Filter the members `delete_item` permissions check.
bp-core/bp-core-template.php: bp_loggedin_user_id()	Get the ID of the currently logged-in user.
bp-core/bp-core-caps.php: bp_current_user_can()	Check whether the current user has a given capability.
bp-core/bp-core-options.php: bp_disable_account_deletion()	Are members able to delete their own accounts?

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents