Home » Hooks » get_avatar

The get_avatar hook is a powerful tool in WordPress that allows developers to modify or replace the default avatar displayed for a user. It is used to customize the avatar image or URL, providing a way to add a unique touch to user profiles or comments.

By default, WordPress uses the Gravatar service to display avatars for users who have registered with the service using their email addresses. However, the get_avatar hook gives developers the ability to override this default behavior and provide their own avatar customization.

The get_avatar hook takes three parameters: $avatar, $id_or_email, and $size. The $avatar parameter is the default avatar HTML or URL, $id_or_email refers to the user’s ID or email address, and $size denotes the desired size of the avatar image.

Developers can use this hook to modify the default avatar by applying filters to the $avatar parameter. For example, they can replace the default Gravatar with a custom image URL or HTML markup. They can also dynamically generate and display avatars based on specific criteria, such as user roles or other metadata.

Here’s an example usage code that demonstrates how to modify the default avatar using the get_avatar hook:

function customize_user_avatar($avatar, $id_or_email, $size) {
    // Check if the user has a custom avatar set
    $custom_avatar = get_user_meta($id_or_email, 'custom_avatar', true);

    if ($custom_avatar) {
        // Return the custom avatar URL
        $avatar = '<img src="' . $custom_avatar . '" width="' . $size . '" height="' . $size . '" />';

    return $avatar;
add_filter('get_avatar', 'customize_user_avatar', 10, 3);

In this example, we’re using the get_user_meta function to check if a user has a custom avatar URL stored in their user meta data under the ‘custom_avatar’ key. If so, we replace the default avatar with the custom image URL.

By utilizing the get_avatar hook, developers can provide a personalized touch to their WordPress websites, enhancing the user experience and adding creative flair to user profiles or comment sections.

Learn More on

Register an account to save your snippets or go Pro to get more features.