pre_get_avatar filter-hook . WP 4.2.0

Allows the HTML for a user's avatar to be returned early.

Passing a non-null value will effectively short-circuit get_avatar(), passing the value through the get_avatar filter and returning early.

Usage

add_filter( 'pre_get_avatar', 'filter_function_name_1928', 10, 3 );
function filter_function_name_1928( $avatar, $id_or_email, $args ){
	// filter...

	return $avatar;
}

$avatar(string|null)

HTML for the user's avatar.
Default: null

$id_or_email(mixed)

The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.

$args(array)

Arguments passed to get_avatar_url(), after processing.

Changelog

Where the hook is called

$avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );

Where in WP core the hook is used WordPress