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

Retrieves the avatar URL.

Contents

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.
  • 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), '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 ↑

Return

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

Top ↑

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

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
get_block_editor_settings() wp-includes/block-editor.php

Returns the contextualized block editor settings for a selected editor context.
WP_Customize_Manager::get_lock_user_data() wp-includes/class-wp-customize-manager.php

Gets lock user data.
rest_get_avatar_urls() wp-includes/rest-api.php

Retrieves the avatar urls in various sizes.
wp_check_locked_posts() wp-admin/includes/misc.php

Checks lock status for posts displayed on the Posts screen.
wp_refresh_post_lock() wp-admin/includes/misc.php

Checks lock status on the New/Edit Post screen and refresh the lock.
get_avatar() wp-includes/pluggable.php

Retrieves the avatar <img> tag for a user, email address, MD5 hash, comment, or post.
Show 1 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
4.2.0 Introduced.

Top ↑

User Contributed Notes

  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    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:

    <picture>
  <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']); ?>"/>
</picture>
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note
    Contributed by PressPage Entertainment Inc —

    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;
</code>

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,

<code>
&lt;?php
$permalink = $_SERVER['REQUEST_URI'];

$username = explode("/",$permalink)[count(explode("/",$permalink))-1];

$user = get_user_by('login',$username);
?&gt;

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