bp_document_user_can_edit( int|BP_Document $document = false )

Determine if the current user can edit an document item.

Description

Parameters

$document

(Optional) BP_Document object or ID of the document.

Default value: false

Return

(bool) True if can edit, false otherwise.

Source

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

function bp_document_user_can_edit( $document = false ) {
 
    // Assume the user cannot edit the document item.
    $can_edit = false;
 
    if ( empty( $document ) ) {
        return $can_edit;
    }
 
    if ( ! is_object( $document ) ) {
        $document = new BP_Document( $document );
    }
 
    if ( empty( $document ) ) {
        return $can_edit;
    }
 
    // Only logged in users can edit document.
    if ( is_user_logged_in() ) {
 
        // Community moderators can always edit document (at least for now).
        if ( bp_current_user_can( 'bp_moderate' ) ) {
            $can_edit = true;
        }
 
        // Users are allowed to edit their own document.
        if ( isset( $document->user_id ) && ( $document->user_id === bp_loggedin_user_id() ) ) {
            $can_edit = true;
        }
 
        if ( bp_is_active( 'groups' ) && $document->group_id > 0 ) {
 
            $manage   = groups_can_user_manage_document( bp_loggedin_user_id(), $document->group_id );
            $status   = bp_group_get_media_status( $document->group_id );
            $is_admin = groups_is_user_admin( bp_loggedin_user_id(), $document->group_id );
            $is_mod   = groups_is_user_mod( bp_loggedin_user_id(), $document->group_id );
 
            if ( $manage ) {
                if ( $document->user_id === bp_loggedin_user_id() ) {
                    $can_edit = true;
                } elseif ( 'members' === $status && ( $is_mod || $is_admin ) ) {
                    $can_edit = true;
                } elseif ( 'mods' == $status && ( $is_mod || $is_admin ) ) {
                    $can_edit = true;
                } elseif ( 'admins' == $status && $is_admin ) {
                    $can_edit = true;
                }
            }
 
        }
 
    }
 
    /**
     * Filters whether the current user can edit an document item.
     *
     * @since BuddyBoss 1.4.2
     *
     * @param bool   $can_edit Whether the user can edit the item.
     * @param object $document   Current document item object.
     */
    return (bool) apply_filters( 'bp_document_user_can_edit', $can_edit, $document );
}

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.php: BP_Document::__construct()	Constructor method.
bp-document/bp-document-template.php: bp_document_user_can_edit	Filters whether the current user can edit an document 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-groups/bp-groups-functions.php: groups_is_user_admin()	Check whether a user is an admin of a given group.
bp-groups/bp-groups-functions.php: groups_is_user_mod()	Check whether a user is a mod of a given group.
bp-groups/bp-groups-template.php: bp_group_get_media_status()	Get the media status of a group.
bp-core/bp-core-template.php: bp_is_active()	Check whether a given component (or feature of a component) is active.
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.

Show 4 more uses Hide more uses

Used By
Used By	Description
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::update_item_permissions_check()	Check if a given request has access to update a document.
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_file()	This function will rename the document name.
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_move()	Ajax document move.
bp-templates/bp-nouveau/includes/document/ajax.php: bp_nouveau_ajax_document_update_file_name()	Update the document name.

Show 2 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