Contents

Code Reference Functions groups_action_leave_group()

groups_action_leave_group()

Catch and process “Leave Group” button clicks.

Description

When a group member clicks on the "Leave Group" button from a group’s page, this function is run.

Note: When leaving a group from the group directory, AJAX is used and another function handles this. See bp_legacy_theme_ajax_joinleave_group().

Return

(bool)

Source

File: bp-groups/actions/leave-group.php

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
function groups_action_leave_group() {
    if ( ! bp_is_single_item() || ! bp_is_groups_component() || ! bp_is_current_action( 'leave-group' ) ) {
        return false;
    }
 
    // Nonce check.
    if ( ! check_admin_referer( 'groups_leave_group' ) ) {
        return false;
    }
 
    // User wants to leave any group.
    if ( groups_is_user_member( bp_loggedin_user_id(), bp_get_current_group_id() ) ) {
        $bp = buddypress();
 
        // Stop sole admins from abandoning their group.
        $group_admins = groups_get_group_admins( bp_get_current_group_id() );
 
        if ( 1 == count( $group_admins ) && $group_admins[0]->user_id == bp_loggedin_user_id() ) {
            bp_core_add_message( __( 'This group must have at least one organizer.', 'buddyboss' ), 'error' );
        } elseif ( ! groups_leave_group( $bp->groups->current_group->id ) ) {
            bp_core_add_message( __( 'There was an error leaving the group.', 'buddyboss' ), 'error' );
        } else {
            bp_core_add_message( __( 'You left the group.', 'buddyboss' ) );
        }
 
        $group = groups_get_current_group();
        $redirect = bp_get_group_permalink( $group );
 
        if ( ! $group->is_visible ) {
            $redirect = trailingslashit( bp_loggedin_user_domain() . bp_get_groups_slug() );
        }
 
        bp_core_redirect( $redirect );
    }
 
    /** This filter is documented in bp-groups/bp-groups-actions.php */
    bp_core_load_template( apply_filters( 'groups_template_group_home', 'groups/single/home' ) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.2.4 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/screens/single/home.php: groups_template_group_home

Filters the template to load for a single group’s page.
bp-groups/bp-groups-functions.php: groups_is_user_member()

Check whether a user is a member of a given group.
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-functions.php: groups_get_group_admins()

Get a list of group administrators.
bp-groups/bp-groups-functions.php: groups_leave_group()

Remove a user from a group.
bp-groups/bp-groups-template.php: bp_get_current_group_id()

Returns the ID of the current group.
bp-groups/bp-groups-template.php: bp_get_group_permalink()

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

Return the groups component slug.
bp-members/bp-members-template.php: bp_loggedin_user_domain()

Generate the link for the logged-in user’s profile.
bp-core/bp-core-template.php: bp_is_groups_component()

Check whether the current page is part of the Groups component.
bp-core/bp-core-template.php: bp_is_single_item()

Are we looking at a single item? (group, user, etc).
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-template.php: bp_loggedin_user_id()

Get the ID of the currently logged-in user.
bp-core/bp-core-functions.php: bp_core_add_message()

Add a feedback (error/success) message to the WP cookie so it can be displayed after the page reloads.
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_load_template()

Load a specific template file with fallback support.
Show 12 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.