Contents

Code Reference Functions bp_groups_group_access_protection()

bp_groups_group_access_protection()

Protect access to single groups.

Description

Source

File: bp-groups/actions/access.php

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
function bp_groups_group_access_protection() {
    if ( ! bp_is_group() ) {
        return;
    }
 
    $current_group   = groups_get_current_group();
    $user_has_access = $current_group->user_has_access;
    $is_visible      = $current_group->is_visible;
    $no_access_args  = array();
 
    // The user can know about the group but doesn't have full access.
    if ( ! $user_has_access && $is_visible ) {
 
        // Always allow access to request-membership.
        if ( bp_is_current_action( 'request-membership' ) ) {
            $user_has_access = true;
 
        // User doesn't have access, so set up redirect args.
        } elseif ( is_user_logged_in() ) {
            $no_access_args = array(
                'message'  => __( 'You do not have access to this group.', 'buddyboss' ),
                'root'     => bp_get_group_permalink( $current_group ) . 'home/',
                'redirect' => false
            );
        }
    }
 
    // Protect the admin tab from non-admins.
    if ( bp_is_current_action( 'admin' ) && ! bp_is_item_admin() ) {
        $user_has_access = false;
        $no_access_args  = array(
            'message'  => __( 'You are not an organizer or moderator of this group.', 'buddyboss' ),
            'root'     => bp_get_group_permalink( $current_group ),
            'redirect' => false
        );
    }
 
    /**
     * Allow plugins to filter whether the current user has access to this group content.
     *
     * Note that if a plugin sets $user_has_access to false, it may also
     * want to change the $no_access_args, to avoid problems such as
     * logged-in users being redirected to wp-login.php.
     *
     * @since BuddyPress 2.1.0
     *
     * @param bool  $user_has_access True if the user has access to the
     *                               content, otherwise false.
     * @param array $no_access_args  Arguments to be passed to bp_core_no_access() in case
     *                               of no access. Note that this value is passed by reference,
     *                               so it can be modified by the filter callback.
     */
    $user_has_access = apply_filters_ref_array( 'bp_group_user_has_access', array( $user_has_access, &$no_access_args ) );
 
    // If user has access, we return rather than redirect.
    if ( $user_has_access ) {
        return;
    }
 
    // Groups that the user cannot know about should return a 404 for non-members.
    // Unset the current group so that you're not redirected
    // to the default group tab.
    if ( ! $is_visible ) {
        buddypress()->groups->current_group = 0;
        buddypress()->is_single_item        = false;
        bp_do_404();
        return;
    } else {
        bp_core_no_access( $no_access_args );
    }
 
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.1.0 Introduced.

Uses

Uses
Uses Description
bp-loader.php: buddypress()

The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-groups/actions/access.php: bp_group_user_has_access

Allow plugins to filter whether the current user has access to this group content.
bp-groups/bp-groups-functions.php: groups_get_current_group()

Get the BP_Groups_Group object corresponding to the current group.
bp-groups/bp-groups-template.php: bp_get_group_permalink()

Return the permalink for the current group in the loop.
bp-core/bp-core-template.php: bp_is_group()

Does the current page belong to a single group?
bp-core/bp-core-template.php: bp_is_item_admin()

Is the logged-in user an admin for the current item?
bp-core/bp-core-template.php: bp_is_current_action()

Check to see whether the current page matches a given action.
bp-core/bp-core-functions.php: bp_do_404()

Trigger a 404.
bp-core/bp-core-functions.php: bp_core_redirect()

Perform a status-safe wp_redirect() that is compatible with BP’s URI parser.
bp-core/bp-core-catchuri.php: bp_core_no_access()

Redirect a user to log in for BP pages that require access control.
Show 5 more uses Hide more uses

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.