WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

rest_get_avatar_urls()

rest_get_avatar_urls( mixed $id_or_email ): (string|false)[]

In this article

Back to top

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

View all references View on Trac View on GitHub

UsesDescription
rest_get_avatar_sizes()wp-includes/rest-api.php

Retrieves the pixel sizes for avatars.

get_avatar_url()wp-includes/link-template.php

Retrieves the avatar URL.

Used byDescription
WP_REST_Users_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

Prepares a single user output for response.

WP_REST_Comments_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Prepares a single comment output for response.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.