bp_get_group_id( object|bool $group = false )

Get the ID of the current group in the loop.

Description

Parameters

$group

(Optional) Group object. Default: current group in loop.

Default value: false

Return

(int)

Source

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

function bp_get_group_id( $group = false ) {
    global $groups_template;
 
    if ( empty( $group ) ) {
        $group =& $groups_template->group;
    }
 
    /**
     * Filters the ID of the current group in the loop.
     *
     * @since BuddyPress 1.0.0
     * @since BuddyPress 2.5.0 Added the `$group` parameter.
     *
     * @param int    $id    ID of the current group in the loop.
     * @param object $group Group object.
     */
    return apply_filters( 'bp_get_group_id', $group->id, $group );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-template.php: bp_get_group_id	Filters the ID of the current group in the loop.

Used By
Used By	Description
bp-groups/bp-groups-template.php: bp_get_group_avatar_url()	Returns the group avatar URL.
bp-groups/bp-groups-template.php: bp_get_group_cover_url()	Returns the group cover image URL.
bp-forums/groups.php: BBP_Forums_Group_Extension::edit_screen()	Show forums and new forum form when editing a group
bp-groups/bp-groups-template.php: bp_get_group_class()	Get the row class of the current group in the loop.
bp-groups/bp-groups-template.php: bp_group_id()	Output the ID of the current group in the loop.
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/template-tags.php: bp_nouveau_group_manage_screen()	Load the requested Manage Screen for the current group.
bp-search/classes/class-bp-search-groups.php: Bp_Search_Groups::generate_html()

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.

Contents