get_avatar_data

SummerySummery

Retrieves default data about the avatar.

Syntax

get_avatar_data( mixed $id_or_email, array $args = null )

ParametersParameters

$id_or_email

(mixed) (Required) The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.

$args

(array) (Optional) Arguments to return instead of the default arguments.

  • 'size'
    (int) Height and width of the avatar image file in pixels. Default 96.
  • 'height'
    (int) Display height of the avatar in pixels. Defaults to $size.
  • 'width'
    (int) Display width of the avatar in pixels. Defaults to $size.
  • '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.
  • 'extra_attr'
    (string) HTML attributes to insert in the IMG element. Is not sanitized. Default empty.

Default value: null

ReturnReturn

(array) Along with the arguments passed in $args, this will contain a couple of extra arguments.

  • 'found_avatar'
    (bool) True if we were able to find an avatar for this user, false or not set if we couldn't.
  • 'url'
    (string) The URL of the avatar we found.

SourceSource

File: wp-includes/link-template.php


			

ChangelogChangelog

Changelog
Version Description
4.2.0 Introduced.
Scroll to Top