On this page
get_avatar_url( mixed $id_or_email, array $args = null ): string|false
Retrieves the avatar URL.
Parameters
$id_or_emailmixed 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.
$argsarray Optional-
Arguments to use instead of the default arguments.
sizeintHeight and width of the avatar in pixels. Default 96.defaultstringURL 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_defaultboolWhether to always show the default image, never the Gravatar. Default false.ratingstringWhat 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.schemestringURL scheme to use. See set_url_scheme() for accepted values.
processed_argsarrayWhen the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference.
Default:
null
Return
string|false The URL of the avatar on success, false on failure.
Source
File: wp-includes/link-template.php. View all references
function get_avatar_url( $id_or_email, $args = null ) {
$args = get_avatar_data( $id_or_email, $args );
return $args['url'];
}
Related
Uses
| Uses | Description |
|---|---|
| get_avatar_data() wp-includes/link-template.php | Retrieves default data about the avatar. |
Used By
| Used By | Description |
|---|---|
| get_block_editor_settings() wp-includes/block-editor.php | Returns the contextualized block editor settings for a selected editor context. |
| WP_Customize_Manager::get_lock_user_data() wp-includes/class-wp-customize-manager.php | Gets lock user data. |
| rest_get_avatar_urls() wp-includes/rest-api.php | Retrieves the avatar urls in various sizes. |
| wp_check_locked_posts() wp-admin/includes/misc.php | Checks lock status for posts displayed on the Posts screen. |
| wp_refresh_post_lock() wp-admin/includes/misc.php | Checks lock status on the New/Edit Post screen and refresh the lock. |
| get_avatar() wp-includes/pluggable.php | Retrieves the avatar |
Changelog
| Version | Description |
|---|---|
| 4.2.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_avatar_url