apply_filters( 'get_avatar_data', array $args , mixed $id_or_email )
Filters the avatar data.
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 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'
(a 8-bit arcade-style pixelated face)'robohash'
(a robot)'monsterid'
(a monster)'wavatar'
(a cartoon face)'identicon'
(the "quilt", a geometric pattern)'mystery'
,'mm'
, or'mysteryman'
(The Oyster Man)'blank'
(transparent GIF)'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'
(suitable for all audiences)'PG'
(possibly offensive, usually for audiences 13 and above)'R'
(intended for adult audiences above 17)'X'
(even more mature than above) 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
return apply_filters( 'get_avatar_data', $args, $id_or_email );
Changelog
Version | Description |
---|---|
4.2.0 | Introduced. |