apply_filters( 'get_avatar_url', string $url, mixed $id_or_email, array $args )

Filters the avatar URL.


Parameters

$url string
The URL of the avatar.
$id_or_email mixed
The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.
$args array
Arguments passed to 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 image file 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' (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.
  • extra_attr string
    HTML attributes to insert in the IMG element. Is not sanitized. Default empty.

Top ↑

Source

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

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


Top ↑

Changelog

Changelog
Version Description
4.2.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    Contributed by thejaydip

    Below is a basic example to return the avatar as a placeholder image.

    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 );

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