Title: get_avatar_url
Published: April 23, 2015
Last modified: August 20, 2026

---

# apply_filters( ‘get_avatar_url’, string $url, mixed $id_or_email, array $args )

## In this article

 * [Parameters](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#parameters)
 * [Source](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#changelog)
 * [User Contributed Notes](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#user-contributed-notes)

[ Back to top](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#wp--skip-link--target)

Filters the avatar URL.

## 󠀁[Parameters](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#parameters)󠁿

 `$url`string

The URL of the avatar.

`$id_or_email`mixed

The avatar to retrieve. Accepts a user ID, Gravatar SHA-256 or MD5 hash, user email,
[WP_User](https://developer.wordpress.org/reference/classes/wp_user/) object, [WP_Post](https://developer.wordpress.org/reference/classes/wp_post/)
object, or [WP_Comment](https://developer.wordpress.org/reference/classes/wp_comment/)
object.

`$args`array

Arguments passed to [get_avatar_data()](https://developer.wordpress.org/reference/functions/get_avatar_data/),
after processing.

More Arguments from get_avatar_data( … $args )

Arguments to use instead of the default arguments.

 * `size` int
 * Height and width of the avatar in pixels. Default 96.
 * `height` int
 * Display height of the avatar in pixels. Defaults to $size.
 * `width` int
 * Display width of the avatar in pixels. Defaults to $size.
 * `default` string
 * 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) 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'` (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.
 * `scheme` string
 * URL scheme to use. See [set_url_scheme()](https://developer.wordpress.org/reference/functions/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
   [‘pre_get_avatar_data’](https://developer.wordpress.org/reference/hooks/pre_get_avatar_data/)
   filter to customize avatars.
 * `processed_args` array
 * When the function returns, the value will be the processed/sanitized $args plus
   a “found_avatar” guess. Pass as a reference.
 * `extra_attr` string
 * HTML attributes to insert in the IMG element. Is not sanitized.

## 󠀁[Source](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#source)󠁿

    ```php
    $args['url'] = apply_filters( 'get_avatar_url', $url, $id_or_email, $args );
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/link-template.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.1/src/wp-includes/link-template.php#L4622)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.1/src/wp-includes/link-template.php#L4622-L4622)

## 󠀁[Related](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#related)󠁿

| Used by | Description | 
| [get_avatar_data()](https://developer.wordpress.org/reference/functions/get_avatar_data/)`wp-includes/link-template.php` |

Retrieves default data about the avatar.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#changelog)󠁿

| Version | Description | 
| [4.2.0](https://developer.wordpress.org/reference/since/4.2.0/) | Introduced. |

## 󠀁[User Contributed Notes](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#user-contributed-notes)󠁿

 1.  [Skip to note 2 content](https://developer.wordpress.org/reference/hooks/get_avatar_url/?output_format=md#comment-content-5941)
 2.   [Jaydip](https://profiles.wordpress.org/iamjaydip/)  [  4 years ago  ](https://developer.wordpress.org/reference/hooks/get_avatar_url/#comment-5941)
 3. [You must log in to vote on the helpfulness of this note](https://login.wordpress.org?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fhooks%2Fget_avatar_url%2F%23comment-5941)
    Vote results for this note: -1[You must log in to vote on the helpfulness of this note](https://login.wordpress.org?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fhooks%2Fget_avatar_url%2F%23comment-5941)
 4. **Below is a basic example to return the avatar as a placeholder image.**
 5.     ```php
        function wdoc_filter_get_avatar_url( $url, $id_or_email, $args ) {
    
        	$url = get_template_directory_uri() . '/author.jpg';
        	return $url;
        }
    
        add_filter( 'get_avatar_url', 'wdoc_filter_get_avatar_url', 10, 3 );
        ```
    
 6.  * Use the `default` parameter in the `$args` array to specify a default image.
       See `[get_avatar_data()](https://developer.wordpress.org/reference/functions/get_avatar_data/)`
       documentation.
     * [crstauf](https://profiles.wordpress.org/crstauf/) [4 years ago](https://developer.wordpress.org/reference/hooks/get_avatar_url/#comment-5944)
 7.  [Log in to add feedback](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fhooks%2Fget_avatar_url%2F%3Freplytocom%3D5941%23feedback-editor-5941)

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fhooks%2Fget_avatar_url%2F)
before being able to contribute a note or feedback.