wordpress / latest / functions / get_avatar_url.html

get_avatar_url( mixed $id_or_email, array $args = null ): string|false

Retrieves the avatar URL.

Parameters

$id_or_email mixed Required
The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.
$args array Optional
Arguments to use instead of the default arguments.
  • sizeint
    Height and width of the avatar in pixels. Default 96.
  • defaultstring
    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_defaultbool
    Whether to always show the default image, never the Gravatar. Default false.
  • ratingstring
    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.
  • schemestring
    URL scheme to use. See set_url_scheme() for accepted values.
  • processed_argsarray
    When the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference.

Default: null

Return

string|false The URL of the avatar on success, false on failure.

Source

File: wp-includes/link-template.php. View all references

function get_avatar_url( $id_or_email, $args = null ) {
	$args = get_avatar_data( $id_or_email, $args );
	return $args['url'];
}

Uses

Uses Description

Used By

Used By Description

Changelog

Version Description
4.2.0 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_avatar_url