bb_get_avatar

Retrieve the avatar for a user provided a user ID or email address.

Description

(string) bb_get_avatar( (int|string) $id_or_email, (int) $size = 80, (string) $default = '', (bool) $alt = false ); 

Returns (string)

tag for the user's avatar

Parameters (4)

0. $id_or_email (int|string)
A user ID or email address
1. $size — Optional. (int) => 80
Size of the avatar image
2. $default — Optional. (string) => ''
URL to a default image to use if no avatar is available
3. $alt — Optional. (bool) => false
Alternate text to use in image tag. Defaults to blank

Usage

  1. if ( !function_exists( 'bb_get_avatar' ) ) { 
  2.     require_once ABSPATH . PLUGINDIR . 'buddypress/bp-forums/bbpress/bb-includes/functions.bb-pluggable.php'; 
  3. } 
  4.   
  5. // A user ID or email address 
  6. $id_or_email = null; 
  7.   
  8. // Size of the avatar image 
  9. $size = 80; 
  10.   
  11. // URL to a default image to use if no avatar is available 
  12. $default = ''; 
  13.   
  14. // Alternate text to use in image tag. Defaults to blank 
  15. $alt = false; 
  16.   
  17. // NOTICE! Understand what this does before running. 
  18. $result = bb_get_avatar($id_or_email, $size, $default, $alt); 
  19.     

Defined (1)

The function is defined in the following location(s).

/bp-forums/bbpress/bb-includes/functions.bb-pluggable.php  
  1. function bb_get_avatar( $id_or_email, $size = 80, $default = '', $alt = false ) { 
  2.     if ( !bb_get_option('avatars_show') ) 
  3.         return false; 
  4.  
  5.     if ( false === $alt) 
  6.         $safe_alt = ''; 
  7.     else 
  8.         $safe_alt = esc_attr( $alt ); 
  9.  
  10.     if ( !is_numeric($size) ) 
  11.         $size = 80; 
  12.  
  13.     if ( $email = bb_get_user_email($id_or_email) ) { 
  14.         $class = 'photo '; 
  15.     } else { 
  16.         $class = ''; 
  17.         $email = $id_or_email; 
  18.     } 
  19.  
  20.     if ( !$email ) 
  21.         $email = ''; 
  22.  
  23.     if ( empty($default) ) 
  24.         $default = bb_get_option('avatars_default'); 
  25.  
  26.      if ( is_ssl() ) 
  27.         $host = 'https://secure.gravatar.com'; 
  28.     else 
  29.         $host = 'http://www.gravatar.com'; 
  30.  
  31.     switch ($default) { 
  32.         case 'logo': 
  33.             $default = ''; 
  34.             break; 
  35.         case 'blank': 
  36.             $default = bb_get_uri( 'bb-admin/images/blank.gif', null, BB_URI_CONTEXT_IMG_SRC ); 
  37.             break; 
  38.         case 'monsterid': 
  39.         case 'wavatar': 
  40.         case 'identicon': 
  41.         case 'retro': 
  42.             break; 
  43.         case 'default': 
  44.         default: 
  45.             $default = $host . '/avatar/ad516503a11cd5ca435acc9bb6523536?s=' . $size; 
  46.             // ad516503a11cd5ca435acc9bb6523536 == md5('unknown@gravatar.com') 
  47.             break; 
  48.     } 
  49.  
  50.     $src = $host . '/avatar/'; 
  51.     $class .= 'avatar avatar-' . $size; 
  52.  
  53.     if ( !empty($email) ) { 
  54.         $src .= md5( strtolower( $email ) ); 
  55.     } else { 
  56.         $src .= 'd41d8cd98f00b204e9800998ecf8427e'; 
  57.         // d41d8cd98f00b204e9800998ecf8427e == md5('') 
  58.         $class .= ' avatar-noemail'; 
  59.     } 
  60.  
  61.     $src .= '?s=' . $size; 
  62.     $src .= '&d=' . urlencode( $default ); 
  63.  
  64.     $rating = bb_get_option('avatars_rating'); 
  65.     if ( !empty( $rating ) ) 
  66.         $src .= '&r=' . $rating; 
  67.  
  68.     $avatar = '<img alt="' . $safe_alt . '" src="' . $src . '" class="' . $class . '" style="height:' . $size . 'px; width:' . $size . 'px;" />'; 
  69.  
  70.     return apply_filters('bb_get_avatar', $avatar, $id_or_email, $size, $default, $alt); 
  71. }