Contents

Code Reference Functions groups_join_group()

groups_join_group( int $group_id, int $user_id )

Add a user to a group.

Description

Parameters

$group_id

(Required) ID of the group.

$user_id

(Optional) ID of the user. Defaults to the currently logged-in user.

Return

(bool) True on success, false on failure.

Source

File: bp-groups/bp-groups-functions.php

607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
function groups_join_group( $group_id, $user_id = 0 ) {
 
    if ( empty( $user_id ) )
        $user_id = bp_loggedin_user_id();
 
    // Check if the user has an outstanding invite. If so, delete it.
    if ( groups_check_user_has_invite( $user_id, $group_id ) )
        groups_delete_invite( $user_id, $group_id );
 
    // Check if the user has an outstanding request. If so, delete it.
    if ( groups_check_for_membership_request( $user_id, $group_id ) )
        groups_delete_membership_request( null, $user_id, $group_id );
 
    // User is already a member, just return true.
    if ( groups_is_user_member( $user_id, $group_id ) )
        return true;
 
    $new_member                = new BP_Groups_Member;
    $new_member->group_id      = $group_id;
    $new_member->user_id       = $user_id;
    $new_member->inviter_id    = 0;
    $new_member->is_admin      = 0;
    $new_member->user_title    = '';
    $new_member->date_modified = bp_core_current_time();
    $new_member->is_confirmed  = 1;
 
    if ( !$new_member->save() )
        return false;
 
    $bp = buddypress();
 
    if ( !isset( $bp->groups->current_group ) || !$bp->groups->current_group || $group_id != $bp->groups->current_group->id )
        $group = groups_get_group( $group_id );
    else
        $group = $bp->groups->current_group;
 
    // Record this in activity feeds.
    if ( bp_is_active( 'activity' ) ) {
        groups_record_activity( array(
            'type'    => 'joined_group',
            'item_id' => $group_id,
            'user_id' => $user_id,
        ) );
    }
 
    /**
     * Fires after a user joins a group.
     *
     * @since BuddyPress 1.0.0
     *
     * @param int $group_id ID of the group.
     * @param int $user_id  ID of the user joining the group.
     */
    do_action( 'groups_join_group', $group_id, $user_id );
 
    return true;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.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/classes/class-bp-groups-member.php: BP_Groups_Member::__construct()

Constructor method.
bp-groups/bp-groups-functions.php: groups_check_for_membership_request()

Check whether a user has an outstanding membership request for a given group.
bp-groups/bp-groups-functions.php: groups_delete_membership_request()

Delete a pending group membership request.
bp-groups/bp-groups-functions.php: groups_check_user_has_invite()

Check to see whether a user has already been invited to a group.
bp-groups/bp-groups-functions.php: groups_delete_invite()

Delete a group invitation.
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_join_group

Fires after a user joins a group.
bp-groups/bp-groups-functions.php: groups_get_group()

Fetch a single group object.
bp-groups/bp-groups-activity.php: groups_record_activity()

Record an activity item related to the Groups component.
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-functions.php: bp_core_current_time()

Get the current GMT time to save into the DB.
Show 8 more uses Hide more uses
Used By
Used By Description
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::create_item()

Add member to a group.
bp-groups/bp-groups-admin.php: bp_groups_admin_load()

Set up the Groups admin page.
bp-groups/actions/join.php: groups_action_join_group()

Catch and process “Join Group” button clicks.
bp-groups/classes/class-bp-groups-member.php: BP_Groups_Member::delete_all_for_user()

Delete all group membership information for the specified user.
bp-groups/bp-groups-functions.php: groups_send_membership_request()

Create a group membership request.
bp-members/bp-members-functions.php: bp_member_add_auto_join_groups()

Add members to Auto Group Membership Approval based on their profile type.
bp-templates/bp-nouveau/includes/groups/ajax.php: bp_nouveau_ajax_joinleave_group()

Join or leave a group when clicking the “join/leave” button via a POST request.
bp-core/bp-core-tools-default-data.php: bp_dd_import_groups_members()

Import groups members.
Show 3 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.