bp_get_group_description( object|bool $group = false )

Return the description for the current group in the loop.

Description

Parameters

$group

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

Default value: false

Return

(string)

Source

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

function bp_get_group_description( $group = false ) {
    global $groups_template;
 
    if ( empty( $group ) ) {
        $group =& $groups_template->group;
    }
 
    /**
     * Filters the description for the current group in the loop.
     *
     * @since BuddyPress 1.0.0
     * @since BuddyPress 2.5.0 Added the `$group` parameter.
     *
     * @param string $value Description for the current group.
     * @param object $group Group object.
     */
    return apply_filters( 'bp_get_group_description', stripslashes( $group->description ), $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_description	Filters the description of the current group.

Used By
Used By	Description
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::prepare_item_for_response()	Prepares group data for return as an object.
bp-groups/bp-groups-template.php: bp_group_description()	Output the description for the current group in the loop.
bp-templates/bp-nouveau/includes/groups/template-tags.php: bp_nouveau_get_group_meta()	Get the group meta.

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