bp_get_group_link( BP_Groups_Group|null $group = null )

Return an HTML-formatted link for the current group in the loop.

Description

Parameters

$group

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

Default value: null

Return

(string)

Source

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

function bp_get_group_link( $group = null ) {
    global $groups_template;
 
    if ( empty( $group ) ) {
        $group =& $groups_template->group;
    }
 
    $link = sprintf(
        '<a href="%s" class="bp-group-home-link %s-home-link">%s</a>',
        esc_url( bp_get_group_permalink( $group ) ),
        esc_attr( bp_get_group_slug( $group ) ),
        esc_html( bp_get_group_name( $group ) )
    );
 
    /**
     * Filters the HTML-formatted link for the current group in the loop.
     *
     * @since BuddyPress 2.9.0
     *
     * @param string          $value HTML-formatted link for the
     *                               current group in the loop.
     * @param BP_Groups_Group $group The current group object.
     */
    return apply_filters( 'bp_get_group_link', $link, $group );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.9.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-template.php: bp_get_group_slug()	Return the slug for the current group in the loop.
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_group_link	Filters the HTML-formatted link for the current group in the loop.
bp-groups/bp-groups-template.php: bp_get_group_name()	Get the name of the current group in the loop.

Used By
Used By	Description
bp-forums/activity.php: BBP_BuddyPress_Activity::group_forum_topic_activity_action_callback()
bp-forums/activity.php: BBP_BuddyPress_Activity::group_forum_reply_activity_action_callback()
bp-groups/screens/user/invites.php: groups_screen_group_invites()	Handle the loading of a user’s Groups > Invites page.
bp-groups/bp-groups-template.php: bp_group_link()	Output an HTML-formatted link for the current group in the loop.

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