get_avatar


get_avatar ( $id_or_email, $size = 96, $default_value = '', $alt = '', $args = null )

Parameters:
  • (mixed) id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.
  • (int) size Optional. Height and width of the avatar in pixels. Default 96.
  • (string) default_value 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) - 'initials' (initials based avatar with background color) - 'color' (generated background color) - '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'.
  • (string) alt Optional. Alternative text to use in the avatar image tag. Default empty.
  • (array) args { Optional. Extra arguments to retrieve the avatar. @type int $height Display height of the avatar in pixels. Defaults to $size. @type int $width Display width of the avatar in pixels. Defaults to $size. @type bool $force_default Whether to always show the default image, never the Gravatar. Default false. @type string $rating 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. @type string $scheme URL scheme to use. See set_url_scheme() for accepted values. Default null. @type array|string $class Array or string of additional classes to add to the img element. Default null. @type bool $force_display Whether to always show the avatar - ignores the show_avatars option. Default false. @type string $loading Value for the `loading` attribute. Default null. @type string $fetchpriority Value for the `fetchpriority` attribute. Default null. @type string $decoding Value for the `decoding` attribute. Default null. @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. Default empty. }
Returns:
  • (string|false) `<img>` tag for the user's avatar. False on failure.
Defined at:
Change Log:
  • 4: .
  • 5: .
  • 6: .
  • 6: .

Description

Retrieves the avatar `` tag for a user, email address, MD5 hash, comment, or post.

Related Functions

get_avatar_url, get_avatar_data, get_metadata, get_tag, get_metadata_raw

Top Google Results

User discussions

wpseek mobile