get_avatar_data
get_avatar_data ( $id_or_email, $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.
- (array) args { Optional. Arguments to use instead of the default arguments. @type int $size Height and width of the avatar in pixels. Default 96. @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 string $default 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'. @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. For Gravatars this setting is ignored and HTTPS is used to avoid unnecessary redirects. The setting is retained for systems using the {@see 'pre_get_avatar_data'} filter to customize avatars. Default null. @type array $processed_args When the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference. Default null. @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. Default empty. }
Returns:- (array) { Along with the arguments passed in `$args`, this will contain a couple of extra arguments. @type bool $found_avatar True if an avatar was found for this user, false or not set if none was found. @type string|false $url The URL of the avatar that was found, or false. }
Defined at:Change Log: - Introduced in WordPress: 4.2.0
- Deprecated in WordPress: —
Description
Retrieves default data about the avatar.