Contents

Code Reference Functions bp_get_signup_avatar()

bp_get_signup_avatar( array|string $args = '' )

Get the user avatar during signup.

Description

See also

Parameters

$args

(Optional) Array of optional arguments.

  • 'size'
    (int) Height/weight in pixels. Default: value of bp_core_avatar_full_width().
  • 'class'
    (string) CSS class. Default: 'avatar'.
  • 'alt'
    (string) HTML 'alt' attribute. Default: 'Your Avatar'.

Default value: ''

Return

(string)

Source

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

2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
function bp_get_signup_avatar( $args = '' ) {
    $bp = buddypress();
 
    $defaults = array(
        'size' => bp_core_avatar_full_width(),
        'class' => 'avatar',
        'alt' => __( 'Your Profile Photo', 'buddyboss' )
    );
 
    $r = wp_parse_args( $args, $defaults );
    extract( $r, EXTR_SKIP );
 
    // Avatar DIR is found.
    if ( $signup_avatar_dir = bp_get_signup_avatar_dir_value() ) {
        $gravatar_img = bp_core_fetch_avatar( array(
            'item_id'    => $signup_avatar_dir,
            'object'     => 'signup',
            'avatar_dir' => 'avatars/signups',
            'type'       => 'full',
            'width'      => $size,
            'height'     => $size,
            'alt'        => $alt,
            'class'      => $class
        ) );
 
        // No avatar DIR was found.
    } else {
 
        // Set default gravatar type.
        if ( empty( $bp->grav_default->user ) )
            $default_grav = 'wavatar';
        elseif ( 'mystery' == $bp->grav_default->user )
            $default_grav = $bp->plugin_url . 'bp-core/images/mystery-man.jpg';
        else
            $default_grav = $bp->grav_default->user;
 
        /**
         * Filters the base Gravatar url used for signup avatars when no avatar dir found.
         *
         * @since BuddyPress 1.0.2
         *
         * @param string $value Gravatar url to use.
         */
        $gravatar_url    = apply_filters( 'bp_gravatar_url', '//www.gravatar.com/avatar/' );
        $md5_lcase_email = md5( strtolower( bp_get_signup_email_value() ) );
        $gravatar_img    = '<img src="' . $gravatar_url . $md5_lcase_email . '?d=' . $default_grav . '&amp;s=' . $size . '" width="' . $size . '" height="' . $size . '" alt="' . $alt . '" class="' . $class . '" />';
    }
 
    /**
     * Filters the user avatar during signup.
     *
     * @since BuddyPress 1.1.0
     *
     * @param string $gravatar_img Avatar HTML image tag.
     * @param array  $args         Array of parsed args for avatar query.
     */
    return apply_filters( 'bp_get_signup_avatar', $gravatar_img, $args );
}

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-members/bp-members-template.php: bp_get_signup_avatar_dir_value()

Get the avatar dir used during signup.
bp-members/bp-members-template.php: bp_get_signup_avatar

Filters the user avatar during signup.
bp-members/bp-members-template.php: bp_get_signup_email_value()

Get the email address submitted during signup.
bp-core/bp-core-avatars.php: bp_core_avatar_full_width()

Get the ‘full’ avatar width setting.
bp-core/bp-core-avatars.php: bp_core_fetch_avatar()

Get an avatar for a BuddyPress object.
bp-members/bp-members-template.php: bp_gravatar_url

Filters the base Gravatar url used for signup avatars when no avatar dir found.
Show 2 more uses Hide more uses
Used By
Used By Description
bp-members/bp-members-template.php: bp_signup_avatar()

Output the user avatar during signup.

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.