apply_filters( 'pre_get_avatar', string|null $avatar, mixed $id_or_email, array $args )

Allows the HTML for a user’s avatar to be returned early.


Returning a non-null value will effectively short-circuit get_avatar() , passing the value through the ‘get_avatar’ filter and returning early.

Top ↑


$avatar string|null
HTML for the user's avatar. Default null.
$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.
$args array
Arguments passed to get_avatar_url() , after processing.
More Arguments from get_avatar_url( ... $args ) Arguments to use instead of the default arguments.
  • size int
    Height and width of the avatar in pixels. Default 96.
  • default string
    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_default bool
    Whether to always show the default image, never the Gravatar. Default false.
  • rating string
    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.
  • scheme string
    URL scheme to use. See set_url_scheme() for accepted values.
  • processed_args array
    When the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference.

Top ↑


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

$avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );

Top ↑


Version Description
4.2.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.