Changeset 31561 for trunk/src/wp-includes/pluggable.php

Timestamp:

02/26/2015 09:16:02 PM (10 years ago)

Author:

wonderboymusic

Message:

In get_avatar_data() and get_avatar(), allow height and width to be specified separately (both default to size). Also allow arbitrary attributes on the <img> via the extra_attr arg.

Props miqrogroove.
See #31469.

File:

• trunk/src/wp-includes/pluggable.php (modified) (7 diffs)

trunk/src/wp-includes/pluggable.php

@@ -2102 +2102 @@
  * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
  *                           user email, WP_User object, WP_Post object, or comment object.
- * @param int    $size       Optional. Height and width of the avatar in pixels. Default 96.
+ * @param int    $size       Optional. Height and width of the avatar image file in pixels. Default 96.
  * @param string $default    Optional. URL for the default image or a default type. Accepts '404'
  *                           (return a 404 instead of a default image), 'retro' (8bit), 'monsterid'
@@ -2113 +2113 @@
  *     Optional. Extra arguments to retrieve the avatar.
  *
+ *     @type int          $height        Display height of the avatar in pixels. Defaults to $size.
+ *     @type int          $width         Display width of the avatar in pixels. Defaults to $size.
  *     @type bool         $force_default Whether to always show the default image, never the Gravatar. Default false.
  *     @type string       $rating        What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
@@ -2122 +2124 @@
  *     @type bool         $force_display Whether to always show the avatar - ignores the show_avatars option.
  *                                       Default false.
+ *     @type string       $extra_attr    HTML attribute to insert in the IMG element.  Has no default and is not sanitized.
  * }
  *
@@ -2130 +2133 @@
         // get_avatar_data() args.
         'size'          => 96,
+        'height'        => null,
+        'width'         => null,
         'default'       => get_option( 'avatar_default', 'mystery' ),
         'force_default' => false,
@@ -2137 +2142 @@
         'class'         => null,
         'force_display' => false,
+        'extra_attr'    => '',
     );
 
@@ -2148 +2154 @@
 
     $args = wp_parse_args( $args, $defaults );
+
+    if ( empty( $args['height'] ) ) {
+        $args['height'] = $args['size'];
+    }
+    if ( empty( $args['width'] ) ) {
+        $args['width'] = $args['size'];
+    }
 
     /**
@@ -2194 +2207 @@
 
     $avatar = sprintf(
-        "<img alt='%s' src='%s' class='%s' height='%d' width='%d' />",
+        "<img alt='%s' src='%s' class='%s' height='%d' width='%d' %s/>",
         esc_attr( $args['alt'] ),
         esc_url( $url ),
         esc_attr( join( ' ', $class ) ),
-        (int) $args['size'],
-        (int) $args['size']
+        (int) $args['height'],
+        (int) $args['width'],
+        $args['extra_attr']
     );