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

Retrieves the avatar URL.


$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.
  • 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' (8bit), 'RoboHash' (robohash), '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.

Default: null

Top ↑


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

Top ↑


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'];

Top ↑


Version Description
4.2.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 2 content
    Contributed by leymannx

    size takes only one integer as this function is meant to always return a square image.

    get_avatar_url($user->ID, ['size' => '51']);

    Example to build a responsive user image:

      <source srcset="<?php print get_avatar_url($user->ID, ['size' => '51']); ?>" media="(min-width: 992px)"/>
      <img src="<?php print get_avatar_url($user->ID, ['size' => '40']); ?>"/>
  2. Skip to note 3 content

    You can use get_avatar_url to create a dynamic favicon from the user’s avatar, this useful when creating a custom user profile,

    &lt;link rel="shortcut icon" href="&lt;?php echo get_avatar_url($user-&gt;ID,array('width'=&gt;'16','height'=&gt;'16')); ?&gt;" /&gt;
    If the profile page uses the user's login, then you can obtain the user ID, where the user's login name is the last item in the request uri,
    $permalink = $_SERVER['REQUEST_URI'];
    $username = explode("/",$permalink)[count(explode("/",$permalink))-1];
    $user = get_user_by('login',$username);

You must log in before being able to contribute a note or feedback.