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

Description

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

Parameters

$avatarstring|null

HTML for the user’s avatar. Default null.

$id_or_emailmixed

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

$argsarray

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' (a 8-bit arcade-style pixelated face)
  • 'robohash' (a robot)
  • 'monsterid' (a monster)
  • 'wavatar' (a cartoon face)
  • 'identicon' (the "quilt", a geometric pattern)
  • 'mystery', 'mm', or 'mysteryman' (The Oyster Man)
  • 'blank' (transparent GIF)
  • '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' (suitable for all audiences)
  • 'PG' (possibly offensive, usually for audiences 13 and above)
  • 'R' (intended for adult audiences above 17)
  • 'X' (even more mature than above) 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.

Source

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

View all references View on Trac View on GitHub

Changelog