云策 WordPress 开发者社区

函数文档

get_avatar_url()

查看官方原文 ↗
💡 云策文档标注

概述

get_avatar_url() 函数用于获取用户头像的 URL，支持多种输入类型和自定义参数。它基于 get_avatar_data() 实现，返回头像 URL 或失败时返回 false。

关键要点

  • 参数 $id_or_email 接受用户 ID、Gravatar 哈希、邮箱、WP_User、WP_Post 或 WP_Comment 对象
  • 可选参数 $args 包括 size（默认 96）、default（默认图像类型）、force_default（强制默认图像）、rating（头像评级）和 scheme（URL 方案）
  • 返回值为字符串（成功时头像 URL）或 false（失败时）
  • 相关函数包括 get_avatar_data()、get_avatar() 等，用于头像数据处理和显示

代码示例

<img src="<?php echo get_avatar_url( get_current_user_id() ); ?>" />

注意事项

  • size 参数应为整数，用于指定正方形头像的像素尺寸
  • 可通过 $args 数组自定义头像，如设置不同尺寸用于响应式设计
  • 函数自 WordPress 4.2.0 版本引入，需确保环境兼容
📄 原文内容

Retrieves the avatar URL.

Parameters

$id_or_emailmixedrequired
The avatar to retrieve a URL for. Accepts a user ID, Gravatar SHA-256 or MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.
$argsarrayoptional
Arguments to use 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' (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() 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:null

Return

string|false The URL of the avatar on success, false on failure.

Source

function get_avatar_url( $id_or_email, $args = null ) {
	$args = get_avatar_data( $id_or_email, $args );
	return $args['url'];
}

View all references View on Trac View on GitHub

Uses Description
get_avatar_data()wp-includes/link-template.php

Retrieves default data about the avatar.
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 <img> tag for a user, email address, MD5 hash, comment, or post.

Show 1 moreShow less

Changelog

Version Description
4.2.0 Introduced.

User Contributed Notes

  2. Skip to note 5 content


    leymannx


    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

    size takes only one integer as this function is meant to always return a square image.

    get_avatar_url($user->ID, ['size' => '51']);

    Example to build a responsive user image:

    <picture>
  <source srcset="<?php print get_avatar_url($user->ID, ['size' => '51']); ?>" media="(min-width: 992px)"/>
  <img src="<?php print get_avatar_url($user->ID, ['size' => '40']); ?>"/>
</picture>

  3. Skip to note 6 content


    PressPage Entertainment Inc


    You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note

    You can use get_avatar_url to create a dynamic favicon from the user’s avatar, this useful when creating a custom user profile,

    <link rel="shortcut icon" href="<?php echo get_avatar_url($user->ID,array('width'=>'16','height'=>'16')); ?>" />
</code>

If the profile page uses the user's login, then you can obtain the user ID, where the user's login name is the last item in the request uri,

<code>
<?php
$permalink = $_SERVER['REQUEST_URI'];

$username = explode("/",$permalink)[count(explode("/",$permalink))-1];

$user = get_user_by('login',$username);
?>