Contents

Code Reference Classes BP_Document_Privacy BP_Document_Privacy::is_document_visible()

BP_Document_Privacy::is_document_visible( bool $document_id = false )

Check if document is visible or not to the logged in user

Description

Parameters

$document_id

(Optional)

Default value: false

Return

(bool|mixed|WP_Error)

Source

File: bp-document/classes/class-bp-document-privacy.php

90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
public function is_document_visible( $document_id = false ) {
    $result = bp_document_get_specific( array( 'document_ids' => $document_id ) );
 
    if ( empty( $result['documents'] ) || empty( $result['documents'][0] ) ) {
        return new WP_Error( 'no_document', __( 'There is no document.', 'buddyboss' ), array( 'status' => 500 ) );
    }
 
    $document   = $result['documents'][0];
    $visibility = $document->privacy;
    $visible    = true;
 
    if ( bp_loggedin_user_id() != $document->user_id ) {
 
        switch ( $visibility ) {
            // Logged in users.
            case 'loggedin':
                if ( ! bp_loggedin_user_id() ) {
                    $visible = false;
                }
                break;
 
            // My friends.
            case 'friends':
                if ( bp_is_active( 'friends' ) ) {
                    $is_friend = friends_check_friendship( bp_loggedin_user_id(), $document->user_id );
                    if ( ! $is_friend ) {
                        $visible = false;
                    }
                }
                break;
 
            // Only group members.
            case 'grouponly':
                if ( bp_is_active( 'groups' ) ) {
                    $group_is_user_member = groups_is_user_member( bp_loggedin_user_id(), $document->activity_id );
                    if ( ! $group_is_user_member ) {
                        $visible = false;
                    }
                }
                break;
 
            // Only Me.
            case 'onlyme':
                if ( bp_loggedin_user_id() != $document->user_id ) {
                    $visible = false;
                }
                break;
 
            default:
                // public.
                break;
        }
    }
 
    if ( is_super_admin() ) {
        $visible = true;
    }
 
    return apply_filters( 'bp_document_is_document_visible', $visible, $visibility, $document_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyBoss 1.4.0 Introduced.

Uses

Uses
Uses Description
bp-document/bp-document-functions.php: bp_document_get_specific()

Fetch specific document items.
bp-groups/bp-groups-functions.php: groups_is_user_member()

Check whether a user is a member of a given group.
bp-friends/bp-friends-functions.php: friends_check_friendship()

Check whether two users are friends.
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.

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.