WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

rest_get_avatar_sizes()

rest_get_avatar_sizes(): int[]

In this article

Back to top

Retrieves the pixel sizes for avatars.

Return

int[] List of pixel sizes for avatars. Default [ 24, 48, 96 ].

Source

function rest_get_avatar_sizes() {
	/**
	 * Filters the REST avatar sizes.
	 *
	 * Use this filter to adjust the array of sizes returned by the
	 * `rest_get_avatar_sizes` function.
	 *
	 * @since 4.4.0
	 *
	 * @param int[] $sizes An array of int values that are the pixel sizes for avatars.
	 *                     Default `[ 24, 48, 96 ]`.
	 */
	return apply_filters( 'rest_avatar_sizes', array( 24, 48, 96 ) );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘rest_avatar_sizes’, int[] $sizes )

Filters the REST avatar sizes.

UsesDescription
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Used byDescription
rest_get_avatar_urls()wp-includes/rest-api.php

Retrieves the avatar URLs in various sizes.

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

Retrieves the user’s schema, conforming to JSON Schema.

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

Retrieves the comment’s schema, conforming to JSON Schema.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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