rest_get_avatar_urls() WordPress Function

The rest_get_avatar_urls() function is used to get the avatar URLs for a user. The function takes two parameters: the user ID and the size of the avatar. The function returns an array of avatar URLs, each of which is a size-specific URL for the user's avatar.

rest_get_avatar_urls( mixed $id_or_email ) #

Retrieves the avatar urls in various sizes.


Description

Top ↑

See also


Top ↑

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.


Top ↑

Return

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


Top ↑

Source

File: wp-includes/rest-api.php

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;
}


Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More