Contents

Code Reference Functions bp_get_activity_avatar()

bp_get_activity_avatar( array|string $args = '' )

Return the avatar of the user that performed the action.

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: 'Profile picture of [user name]' if activity user name is available, otherwise 'Profile picture'.
  • 'class'
    (string) Default: 'avatar'.
  • 'email'
    (string|bool) Default: Email of the activity's associated user, if available. Otherwise false.
  • 'type'
    (string) Default: 'full' when viewing a single activity permalink page, otherwise 'thumb'.
  • 'user_id'
    (int|bool) Default: ID of the activity's user.

Default value: ''

Return

(string) User avatar string.

Source

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

1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
function bp_get_activity_avatar( $args = '' ) {
    global $activities_template;
 
    $bp = buddypress();
 
    // On activity permalink pages, default to the full-size avatar.
    $type_default = bp_is_single_activity() ? 'full' : 'thumb';
 
    // Within the activity comment loop, the current activity should be set
    // to current_comment. Otherwise, just use activity.
    $current_activity_item = isset( $activities_template->activity->current_comment ) ? $activities_template->activity->current_comment : $activities_template->activity;
 
    // Activity user display name.
    $dn_default  = isset( $current_activity_item->display_name ) ? $current_activity_item->display_name : '';
 
    // Prepend some descriptive text to alt.
    $alt_default = !empty( $dn_default ) ? sprintf( __( 'Profile photo of %s', 'buddyboss' ), $dn_default ) : __( 'Profile photo', 'buddyboss' );
 
    $defaults = array(
        'alt'     => $alt_default,
        'class'   => 'avatar',
        'email'   => false,
        'type'    => $type_default,
        'user_id' => false
    );
 
    $r = wp_parse_args( $args, $defaults );
    extract( $r, EXTR_SKIP );
 
    if ( !isset( $height ) && !isset( $width ) ) {
 
        // Backpat.
        if ( isset( $bp->avatar->full->height ) || isset( $bp->avatar->thumb->height ) ) {
            $height = ( 'full' == $type ) ? $bp->avatar->full->height : $bp->avatar->thumb->height;
        } else {
            $height = 20;
        }
 
        // Backpat.
        if ( isset( $bp->avatar->full->width ) || isset( $bp->avatar->thumb->width ) ) {
            $width = ( 'full' == $type ) ? $bp->avatar->full->width : $bp->avatar->thumb->width;
        } else {
            $width = 20;
        }
    }
 
    /**
     * Filters the activity avatar object based on current activity item component.
     *
     * This is a variable filter dependent on the component used.
     * Possible hooks are bp_get_activity_avatar_object_blog,
     * bp_get_activity_avatar_object_group, and bp_get_activity_avatar_object_user.
     *
     * @since BuddyPress 1.1.0
     *
     * @param string $component Component being displayed.
     */
    $object  = apply_filters( 'bp_get_activity_avatar_object_' . $current_activity_item->component, 'user' );
    $item_id = !empty( $user_id ) ? $user_id : $current_activity_item->user_id;
 
    /**
     * Filters the activity avatar item ID.
     *
     * @since BuddyPress 1.2.10
     *
     * @param int $item_id Item ID for the activity avatar.
     */
    $item_id = apply_filters( 'bp_get_activity_avatar_item_id', $item_id );
 
    // If this is a user object pass the users' email address for Gravatar so we don't have to prefetch it.
    if ( 'user' == $object && empty( $user_id ) && empty( $email ) && isset( $current_activity_item->user_email ) ) {
        $email = $current_activity_item->user_email;
    }
 
    /**
     * Filters the value returned by bp_core_fetch_avatar.
     *
     * @since BuddyPress 1.1.3
     *
     * @param array $value HTML image element containing the activity avatar.
     */
    return apply_filters( 'bp_get_activity_avatar', bp_core_fetch_avatar( array(
        'item_id' => $item_id,
        'object'  => $object,
        'type'    => $type,
        'alt'     => $alt,
        'class'   => $class,
        'width'   => $width,
        'height'  => $height,
        'email'   => $email
    ) ) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.1.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-core/bp-core-template.php: bp_is_single_activity()

Is the current page a single activity item permalink?
bp-core/bp-core-avatars.php: bp_core_fetch_avatar()

Get an avatar for a BuddyPress object.
bp-activity/bp-activity-template.php: bp_get_activity_avatar_object_{$current_activity_item->component}

Filters the activity avatar object based on current activity item component.
bp-activity/bp-activity-template.php: bp_get_activity_avatar_item_id

Filters the activity avatar item ID.
bp-activity/bp-activity-template.php: bp_get_activity_avatar

Filters the value returned by bp_core_fetch_avatar.
Show 1 more use Hide more uses
Used By
Used By Description
bp-activity/bp-activity-template.php: bp_activity_avatar()

Output the avatar of the user that performed the action.

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.