Contents

Code Reference Functions bp_get_group_avatar()

bp_get_group_avatar( array|string $args = '' )

Get a group’s avatar.

Description

See also

Parameters

$args

(Optional) Arguments are listed here with an explanation of their defaults. For more information about the arguments, see bp_core_fetch_avatar().

  • 'alt'
    (string) Default: 'Group logo of [group name]'.
  • 'class'
    (string) Default: 'avatar'.
  • 'type'
    (string) Default: 'full'.
  • 'width'
    (int|bool) Default: false.
  • 'height'
    (int|bool) Default: false.
  • 'id'
    (bool) Passed to $css_id parameter.

Default value: ''

Return

(string) Group avatar string.

Source

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

898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
function bp_get_group_avatar( $args = '' ) {
    global $groups_template;
 
    // Bail if avatars are turned off.
    if ( bp_disable_group_avatar_uploads() || ! buddypress()->avatar->show_avatars ) {
        return false;
    }
 
    // Parse the arguments.
    $r = bp_parse_args( $args, array(
        'type'   => 'full',
        'width'  => false,
        'height' => false,
        'class'  => 'avatar',
        'id'     => false,
        'alt'    => sprintf( __( 'Group logo of %s', 'buddyboss' ), $groups_template->group->name )
    ) );
 
    // Fetch the avatar from the folder.
    $avatar = bp_core_fetch_avatar( array(
        'item_id'    => $groups_template->group->id,
        'avatar_dir' => 'group-avatars',
        'object'     => 'group',
        'type'       => $r['type'],
        'alt'        => $r['alt'],
        'css_id'     => $r['id'],
        'class'      => $r['class'],
        'width'      => $r['width'],
        'height'     => $r['height'],
    ) );
 
    // If No avatar found, provide some backwards compatibility.
    if ( empty( $avatar ) ) {
        $avatar = '<img src="' . esc_url( $groups_template->group->avatar_thumb ) . '" class="avatar" alt="' . esc_attr( $groups_template->group->name ) . '" />';
    }
 
    /**
     * Filters the group avatar while in the groups loop.
     *
     * @since BuddyPress 1.0.0
     *
     * @param string $avatar HTML image element holding the group avatar.
     * @param array  $r      Array of parsed arguments for the group avatar.
     */
    return apply_filters( 'bp_get_group_avatar', $avatar, $r );
}

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/bp-groups-template.php: bp_get_group_avatar

Filters the group avatar while in the groups loop.
bp-core/bp-core-functions.php: bp_parse_args()

Merge user defined arguments into defaults array.
bp-core/bp-core-avatars.php: bp_core_fetch_avatar()

Get an avatar for a BuddyPress object.
bp-core/bp-core-options.php: bp_disable_group_avatar_uploads()

Are group avatars disabled?
Used By
Used By Description
bp-groups/bp-groups-template.php: bp_get_group_avatar_thumb()

Return the group avatar thumbnail while in the groups loop.
bp-groups/bp-groups-template.php: bp_get_group_avatar_mini()

Return the miniature group avatar thumbnail while in the groups loop.
bp-groups/bp-groups-template.php: bp_group_avatar()

Output the group avatar while in the groups 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.