get_avatar_url( mixed $id_or_email, array $args = null )
Retrieves the avatar URL.
Parameters
- $id_or_email
-
(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
-
(Optional) Arguments to use instead of the default arguments.<br>
- 'size'
(int) Height and width of the avatar in pixels. Default 96.<br> - 'default'
(string) URL for the default image or a default type. Accepts:<br>- '404' (return a 404 instead of a default image)<br>
- 'retro' (a 8-bit arcade-style pixelated face)<br>
- 'robohash' (a robot)<br>
- 'monsterid' (a monster)<br>
- 'wavatar' (a cartoon face)<br>
- 'identicon' (the "quilt", a geometric pattern)<br>
- 'initials' (initials based avatar with background color)<br>
- 'color' (generated background color)<br>
- 'mystery', 'mm', or 'mysteryman' (The Oyster Man)<br>
- 'blank' (transparent GIF)<br>
- 'gravatar_default' (the Gravatar logo) Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.<br>
- 'force_default'
(bool) Whether to always show the default image, never the Gravatar.<br> Default false.<br> - 'rating'
(string) What rating to display avatars up to. Accepts:<br> - 'G' (suitable for all audiences)<br>
- 'PG' (possibly offensive, usually for audiences 13 and above)<br>
- 'R' (intended for adult audiences above 17)<br>
- 'X' (even more mature than above) Default is the value of the 'avatar_rating' option.<br>
- 'scheme'
(string) URL scheme to use. See set_url_scheme() for accepted values.<br> <br>- 'processed_args'
(array) When the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference. <br>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'];
}
Changelog
| Version | Description |
|---|---|
| 4.2.0 | Introduced. |