W3cubDocs

/WordPress

apply_filters( 'pre_get_avatar', string|null $avatar, mixed $id_or_email, array $args )

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

Description

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

Parameters

$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.

Source

File: wp-includes/pluggable.php

View on Trac

Changelog

Version Description
4.2.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/pre_get_avatar