bp_folder_user_can_edit( int|BP_Document_Folder $folder = false )

Determine if the current user can edit an folder item.

Description

Parameters

$folder

(Optional) BP_Document_Folder object or ID of the folder.

Default value: false

Return

(bool) True if can edit, false otherwise.

Source

File: bp-document/bp-document-template.php

function bp_folder_user_can_edit( $folder = false ) {
 
    // Assume the user cannot edit the folder item.
    $can_edit = false;
 
    if ( empty( $folder ) ) {
        return $can_edit;
    }
 
    if ( ! is_object( $folder ) ) {
        $folder = new BP_Document_Folder( $folder );
    }
 
    if ( empty( $folder ) ) {
        return $can_edit;
    }
 
    // Only logged in users can edit folder.
    if ( is_user_logged_in() ) {
 
        // Users are allowed to edit their own folder.
        if ( isset( $folder->user_id ) && bp_loggedin_user_id() === $folder->user_id ) {
            $can_edit = true;
        // Community moderators can always edit folder (at least for now).
        } elseif ( bp_current_user_can( 'bp_moderate' ) ) {
            $can_edit = true;
        // Groups documents have their own access.
        } elseif ( ! empty( $folder->group_id ) && groups_can_user_manage_document( bp_loggedin_user_id(), $folder->group_id ) ) {
            $can_edit = true;
        }
 
    }
 
    /**
     * Filters whether the current user can edit an folder item.
     *
     * @since BuddyBoss 1.4.2
     *
     * @param bool   $can_edit Whether the user can edit the item.
     * @param object $folder   Current folder item object.
     */
    return (bool) apply_filters( 'bp_folder_user_can_delete', $can_edit, $folder );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyBoss 1.4.2	Introduced.

Uses

Uses
Uses	Description
bp-document/classes/class-bp-document-folder.php: BP_Document_Folder::__construct()	Constructor method.
bp-document/bp-document-template.php: bp_folder_user_can_delete	Filters whether the current user can edit an folder item.
bp-groups/bp-groups-functions.php: groups_can_user_manage_document()	Check whether a user is allowed to manage document in a given group.
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.

Used By
Used By	Description
bp-document/classes/class-bp-rest-document-folder-endpoint.php: BP_REST_Document_Folder_Endpoint::create_item_permissions_check()	Check if a given request has access to create a folder.
bp-document/classes/class-bp-rest-document-folder-endpoint.php: BP_REST_Document_Folder_Endpoint::update_item()	Update a folder.
bp-document/classes/class-bp-rest-document-folder-endpoint.php: BP_REST_Document_Folder_Endpoint::update_item_permissions_check()	Check if a given request has access to update a document.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::create_item_permissions_check()	Check if a given request has access to create a document.
bp-document/bp-document-functions.php: bp_document_move_folder_to_folder()	This function will move folder to another destination folder id.
bp-document/bp-document-functions.php: bp_document_update_privacy()	Update document privacy with nested level.
bp-document/bp-document-functions.php: bp_document_move_document_to_folder()	This function will document into the folder.
bp-document/bp-document-functions.php: bp_document_rename_folder()	This function will rename the folder name.
bp-templates/bp-nouveau/includes/document/ajax.php: bp_nouveau_ajax_document_edit_folder()	Rename folder.
bp-templates/bp-nouveau/includes/document/ajax.php: bp_nouveau_ajax_document_folder_move()	Move folder to another folder.
bp-templates/bp-nouveau/includes/document/ajax.php: bp_nouveau_ajax_document_save_privacy()
bp-templates/bp-nouveau/includes/document/ajax.php: bp_nouveau_ajax_document_folder_save()	Save folder
bp-templates/bp-nouveau/includes/document/ajax.php: bp_nouveau_ajax_document_child_folder_save()
bp-templates/bp-nouveau/includes/document/ajax.php: bp_nouveau_ajax_document_move()	Ajax document move.
bp-templates/bp-nouveau/includes/document/ajax.php: bp_nouveau_ajax_document_update_file_name()	Update the document name.

Show 10 more used by Hide more used by

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