Filters the HTML for a user’s avatar.

$avatar string

HTML for the user's avatar.

$id_or_email mixed

The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.

$size int

Square avatar width and height in pixels to retrieve.

$default string

URL for the default image or a default type. Accepts '404', 'retro', 'monsterid', 'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'.

$alt string

Alternative text to use in the avatar image tag.

$args array

Arguments passed to get_avatar_data() , after processing.

More Arguments from get_avatar_data( ... $args )

Arguments to use instead of the default arguments.

• sizeint
  Height and width of the avatar image file in pixels. Default 96.
• heightint
  Display height of the avatar in pixels. Defaults to $size.
• widthint
  Display width of the avatar in pixels. Defaults to $size.
• defaultstring
  URL for the default image or a default type. Accepts '404' (return a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF), or 'gravatar_default' (the Gravatar logo). Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.
• force_defaultbool
  Whether to always show the default image, never the Gravatar. Default false.
• ratingstring
  What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are judged in that order. Default is the value of the 'avatar_rating' option.
• schemestring
  URL scheme to use. See set_url_scheme() for accepted values.
  
• processed_argsarray
  When the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference.
• extra_attrstring
  HTML attributes to insert in the IMG element. Is not sanitized. Default empty.

The “get_avatar” filter can be used to alter the avatar image returned by the get_avatar() function.

There are two tricky parts to using this filter:

1. get_avatar() can be passed a user ID, user object or email address. So we will not know what we are looking at and will need to check for them all.
2. It returns the entire image html string with classes, alt, and src. So you need to recreate the entire thing, not just send back the image url.

File: wp-includes/pluggable.php. View all references

return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );