pre_get_avatar_data │ filter-hook │ WP 4.2.0

Filters whether to retrieve the avatar URL early.

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.

Usage

add_filter( 'pre_get_avatar_data', 'wp_kama_pre_get_avatar_data_filter', 10, 2 );

/**
 * Function for `pre_get_avatar_data` filter-hook.
 * 
 * @param array $args        Arguments passed to get_avatar_data(), after processing.
 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar SHA-256 or MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.
 *
 * @return array
 */
function wp_kama_pre_get_avatar_data_filter( $args, $id_or_email ){

	// filter...
	return $args;
}

$args(array)

Arguments passed to get_avatar_data(), after processing.

$id_or_email(mixed)

The avatar to retrieve. Accepts a user ID, Gravatar SHA-256 or MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.

Changelog

Where the hook is called

$args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email );

Where the hook is used in WordPress