get_avatar_url() WordPress Function
The get_avatar_url() function is used to retrieve the URL for an avatar image. The function takes two parameters: the user ID or email address of the user, and the size of the avatar image. The function returns the URL of the avatar image.
get_avatar_url( mixed $id_or_email, array $args = null ) #
Retrieves the avatar URL.
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 return 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 value: null
- 'size'
Return
(string|false) The URL of the avatar on success, false on failure.
Source
File: wp-includes/link-template.php
function get_avatar_url( $id_or_email, $args = null ) {
$args = get_avatar_data( $id_or_email, $args );
return $args['url'];
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.2.0 | Introduced. |