Contents

Code Reference Classes BP_REST_Document_Folder_Endpoint BP_REST_Document_Folder_Endpoint::delete_item_permissions_check()

BP_REST_Document_Folder_Endpoint::delete_item_permissions_check( WP_REST_Request $request )

Checks if a given request has access to for the user.

Description

Parameters

$request

(Required) Full details about the request.

Return

(bool)

Source

File: bp-document/classes/class-bp-rest-document-folder-endpoint.php

830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
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 delete this folder.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    $folder = new BP_Document_Folder( $request['id'] );
 
    if ( true === $retval && empty( $folder->id ) ) {
        $retval = new WP_Error(
            'bp_rest_folder_invalid_id',
            __( 'Invalid Folder ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( true === $retval && ! bp_folder_user_can_delete( $folder ) ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to delete this folder.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the document folder `delete_item` permissions check.
     *
     * @param bool            $retval  Returned value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_document_folder_delete_item_permissions_check', $retval, $request );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

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.