apply_filters( 'pre_get_avatar_data', array $args , mixed $id_or_email )
Filters whether to retrieve the avatar URL early.
Description
Passing a non-null value in the ‘url’ member of the return array will effectively short circuit get_avatar_data() , passing the value through the ‘get_avatar_data’ filter and returning early.
Parameters
-
$args
array -
Arguments passed to get_avatar_data() , after processing.
More Arguments from get_avatar_data( ... $args )
Arguments to use instead of the default arguments.
size
intHeight and width of the avatar image file in pixels. Default 96.height
intDisplay height of the avatar in pixels. Defaults to $size.width
intDisplay width of the avatar in pixels. Defaults to $size.default
stringURL for the default image or a default type. Accepts'404'
(return a 404 instead of a default image),'retro'
(8bit),'monsterid'
(monster),'wavatar'
(cartoon face),'indenticon'
(the "quilt"),'mystery'
,'mm'
, or'mysteryman'
(The Oyster Man),'blank'
(transparent GIF), or'gravatar_default'
(the Gravatar logo). Default is the value of the'avatar_default'
option, with a fallback of'mystery'
.force_default
boolWhether to always show the default image, never the Gravatar. Default false.rating
stringWhat rating to display avatars up to. Accepts'G'
,'PG'
,'R'
,'X'
, and are judged in that order. Default is the value of the'avatar_rating'
option.scheme
stringprocessed_args
arrayWhen the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference.extra_attr
stringHTML attributes to insert in the IMG element. Is not sanitized. Default empty.
-
$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.
Source
File: wp-includes/link-template.php
.
View all references
$args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email );
Changelog
Version | Description |
---|---|
4.2.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Can be used to display an image from your media library for a specific user to prevent requests to Gravatar and speed things up.
Be sure to replace “author_email_to_check”, “author_id_to_check” and “attachment_id_to_display” to their corresponding values.