Ticket #6622: 6622.01.patch

src/bp-core/bp-core-avatars.php

@@ -172 +172 @@
  *     @type bool       $html        Whether to return an <img> HTML element, vs a raw URL
  *                                   to an avatar. If false, <img>-specific arguments (like 'css_id')
  *                                   will be ignored. Default: true.
+ *     @type string     $extra_attr  HTML attributes to insert in the IMG element. Not sanitized. Default: ''.
+ *                                   New as of WP 4.2.0 via get_avatar().
  * }
  *
  * @return string Formatted HTML <img> element, or raw avatar URL based on $html arg.
@@ -201 +203 @@
                 'no_grav'    => false,
                 'html'       => true,
                 'title'      => '',
+                'extra_attr' => '',
         ) );
 
         /** Set item_id ***********************************************************/
@@ -415 +418 @@
         // populate the class attribute
         $html_class = ' class="' . join( ' ', $avatar_classes ) . ' photo"';
 
+        // Extra attributes
+        $extra_attr = ! empty( $args['extra_attr'] ) ? $args['extra_attr'] : '';
+
         // Set img URL and DIR based on prepopulated constants
         $avatar_loc        = new stdClass();
         $avatar_loc->path  = trailingslashit( bp_core_avatar_upload_path() );
@@ -524 +530 @@
                                  * @param string $avatar_folder_url Avatar URL path.
                                  * @param string $avatar_folder_dir Avatar dir path.
                                  */
-                                return apply_filters( 'bp_core_fetch_avatar', '<img src="' . $avatar_url . '"' . $html_class . $html_css_id  . $html_width . $html_height . $html_alt . $html_title . ' />', $params, $params['item_id'], $params['avatar_dir'], $html_css_id, $html_width, $html_height, $avatar_folder_url, $avatar_folder_dir );
+                                return apply_filters( 'bp_core_fetch_avatar', '<img src="' . $avatar_url . '"' . $html_class . $html_css_id  . $html_width . $html_height . $html_alt . $html_title . $extra_attr . ' />', $params, $params['item_id'], $params['avatar_dir'], $html_css_id, $html_width, $html_height, $avatar_folder_url, $avatar_folder_dir );
 
                         // ...or only the URL
                         } else {
@@ -626 +632 @@
         if ( true === $params['html'] ) {
 
                 /** This filter is documented in bp-core/bp-core-avatars.php */
-                return apply_filters( 'bp_core_fetch_avatar', '<img src="' . $gravatar . '"' . $html_css_id . $html_class . $html_width . $html_height . $html_alt . $html_title . ' />', $params, $params['item_id'], $params['avatar_dir'], $html_css_id, $html_width, $html_height, $avatar_folder_url, $avatar_folder_dir );
+                return apply_filters( 'bp_core_fetch_avatar', '<img src="' . $gravatar . '"' . $html_css_id . $html_class . $html_width . $html_height . $html_alt . $html_title . $extra_attr . ' />', $params, $params['item_id'], $params['avatar_dir'], $html_css_id, $html_width, $html_height, $avatar_folder_url, $avatar_folder_dir );
         } else {
 
                 /** This filter is documented in bp-core/bp-core-avatars.php */
@@ -1281 +1287 @@
 /**
  * Replace default WordPress avatars with BP avatars, if available.
  *
- * Filters 'get_avatar'.
+ * See 'get_avatar' filter description in wp-includes/pluggable.php.
  *
  * @param string            $avatar  The avatar path passed to 'get_avatar'.
  * @param int|string|object $user    A user ID, email address, or comment object.
  * @param int               $size    Size of the avatar image ('thumb' or 'full').
  * @param string            $default URL to a default image to use if no avatar is available.
  * @param string            $alt     Alternate text to use in image tag. Default: ''.
+ * @param array             $args    Arguments passed to get_avatar_data(), after processing.
  *
  * @return string BP avatar path, if found; else the original avatar path.
  */
-function bp_core_fetch_avatar_filter( $avatar, $user, $size, $default, $alt = '' ) {
+function bp_core_fetch_avatar_filter( $avatar, $user, $size, $default, $alt = '', $args = array() ) {
         global $pagenow;
 
         // Do not filter if inside WordPress options page
@@ -1332 +1339 @@
                 $type = 'full';
         }
 
-        // Let BuddyPress handle the fetching of the avatar
-        $bp_avatar = bp_core_fetch_avatar( array(
+        $avatar_args = array(
                 'item_id' => $id,
                 'type'    => $type,
                 'width'   => $size,
                 'height'  => $size,
                 'alt'     => $alt,
-        ) );
+        );
+        if ( ! empty( $args['class'] ) ) {
+                $avatar_args['class'] = $args['class'];
+        }
+        if ( ! empty( $args['extra_attr'] ) ) {
+                $avatar_args['extra_attr'] = $args['extra_attr'];
+        }
+
+        // Let BuddyPress handle the fetching of the avatar
+        $bp_avatar = bp_core_fetch_avatar( $avatar_args );
 
         // If BuddyPress found an avatar, use it. If not, use the result of get_avatar
         return ( !$bp_avatar ) ? $avatar : $bp_avatar;
 }
-add_filter( 'get_avatar', 'bp_core_fetch_avatar_filter', 10, 5 );
+add_filter( 'get_avatar', 'bp_core_fetch_avatar_filter', 10, 6 );
 
 /**
  * Is the current avatar upload error-free?