get_avatar WordPress Filter Hook
The get_avatar hook is used to retrieve the avatar for a user. It takes two parameters: the user ID and the size of the avatar. The function returns the HTML for the avatar.
apply_filters( 'get_avatar', string $avatar , mixed $id_or_email , int $size , string $default , 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
(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 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
Changelog
| Version | Description |
|---|---|
| 4.2.0 | The $args parameter was added. |
| 2.5.0 | Introduced. |