apply_filters( 'get_avatar', string $avatar , mixed $id_or_email , int $size , string $default_value , string $alt , array $args )
Filters the HTML for a user’s avatar.
Parameters
-
$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_value
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.
size
intHeight and width of the avatar image file in pixels. Default 96.height
intDisplay height of the avatar in pixels. Defaults to $size.width
intDisplay width of the avatar in pixels. Defaults to $size.default
stringURL 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_default
boolWhether to always show the default image, never the Gravatar. Default false.rating
stringWhat 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.scheme
stringprocessed_args
arrayWhen the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference.extra_attr
stringHTML attributes to insert in the IMG element. Is not sanitized. Default empty.
More Information
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:
- 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.
- 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.
Source
File: wp-includes/pluggable.php
.
View all references
return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
Changelog
Version | Description |
---|---|
4.2.0 | The $args parameter was added. |
2.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example migrating from Codex:
In this example, I am looking for user with an id of 1 and sending back a custom image.