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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$id_or_emailmixed

The avatar to retrieve a URL for. Accepts a user ID, Gravatar SHA-256 or MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.

$argsarrayoptional

Arguments to use instead of the default arguments.Default: null

• $sizeintdefault: 96

  Height and width of the avatar in pixels.

• $defaultstringdefault: is the value of the 'avatar_default' option, with a fallback of 'mystery'

  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)
  • 'initials' (initials based avatar with background color)
  • 'color' (generated background color)
  • 'mystery', 'mm', or 'mysteryman' (The Oyster Man)
  • 'blank' (transparent GIF)
  • 'gravatar_default' (the Gravatar logo)

• $force_defaultbooldefault: false

  Whether to always show the default image, never the Gravatar.

• $ratingstringdefault: is the value of the 'avatar_rating' option

  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)

• $schemestringdefault: null

  URL scheme to use. See set_url_scheme() for accepted values.

• $processed_argsarraydefault: null

  When the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference.

Return value

string|false

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

Performance profile

How much work a call to get_avatar_url() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_user_by().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9

Executed per call on PHP 8.5. The body compiles to 9.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

6

6 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()one call below get_avatar_url()
• hookthird-party callbacksapply_filters()one call below get_avatar_url()
• querycontent queryget_user_by()one call below get_avatar_url()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_avatar_url() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• get_avatar_data()Retrieves default data about the avatar.

Used by · 6

• WP_Customize_Manager::get_lock_user_data()Gets lock user data.
• get_avatar()Retrieves the avatar `` tag for a user, email address, MD5 hash, comment, or post.
• get_block_editor_settings()Returns the contextualized block editor settings for a selected editor context.
• rest_get_avatar_urls()Retrieves the avatar URLs in various sizes.
• wp_check_locked_posts()Checks lock status for posts displayed on the Posts screen.
• wp_refresh_post_lock()Checks lock status on the New/Edit Post screen and refresh the lock.

Source code

View on Trac ↗View on GitHub ↗

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

Changelog

Introduced in 4.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.