函数文档

rest_get_avatar_urls()

💡 云策文档标注

概述

rest_get_avatar_urls() 函数用于获取指定用户或实体的多种尺寸头像 URL。它基于 rest_get_avatar_sizes() 返回的尺寸数组,调用 get_avatar_url() 生成 URL 列表。

关键要点

  • 函数接受混合类型参数 $id_or_email,支持用户 ID、Gravatar MD5 哈希、用户邮箱、WP_User 对象、WP_Post 对象或 WP_Comment 对象。
  • 返回一个数组,键为头像尺寸,值为 URL 字符串或布尔值 false(表示无头像)。
  • 内部使用 get_avatar_url() 函数生成每个尺寸的 URL。
  • 在 WordPress 4.7.0 版本中引入。

代码示例

function rest_get_avatar_urls( $id_or_email ) {
    $avatar_sizes = rest_get_avatar_sizes();

    $urls = array();
    foreach ( $avatar_sizes as $size ) {
        $urls[ $size ] = get_avatar_url( $id_or_email, array( 'size' => $size ) );
    }

    return $urls;
}

注意事项

  • 相关函数包括 rest_get_avatar_sizes() 和 get_avatar_url(),用于获取尺寸列表和单个头像 URL。
  • 该函数被 WP_REST_Users_Controller 和 WP_REST_Comments_Controller 的 prepare_item_for_response() 方法使用,以在 REST API 响应中提供头像数据。

📄 原文内容

Retrieves the avatar URLs in various sizes.

Description

See also

Parameters

$id_or_emailmixedrequired
The avatar to retrieve a URL for. Accepts a user ID, Gravatar MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.

Return

(string|false)[] Avatar URLs keyed by size. Each value can be a URL string or boolean false.

Source

function rest_get_avatar_urls( $id_or_email ) {
	$avatar_sizes = rest_get_avatar_sizes();

	$urls = array();
	foreach ( $avatar_sizes as $size ) {
		$urls[ $size ] = get_avatar_url( $id_or_email, array( 'size' => $size ) );
	}

	return $urls;
}

Changelog

Version Description
4.7.0 Introduced.