How to use avatar_defaults filter in WordPress

avatar_defaults filter

Avatars are stored in key/value pairs, where the key is the option value, and the name is the displayed avatar name.

To use the avatar_defaults filter, you first need to register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function modify_avatar_defaults_defaults which takes 1 parameter and we registered it using add_filter. The first parameter avatar_defaults is the name of the hook, the second parameter modify_avatar_defaults_defaults is the name of the function that needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook, so you can use remove_filter to remove the avatar_defaults filter.

Parameters

Below the 1 parameter is required to use this hook.

• $avatar_defaults: (string[]) Associative array of default avatars.

Live Example

Example 1: Adding a New Default Gravatar

This example demonstrates how to add a new default Gravatar to the list of available avatars.

    function weplugins_new_gravatar( $avatar_defaults ) {
        $new_default_avatar = 'https://mysite.com/wp-content/uploads/user.jpg';
        $avatar_defaults[ $new_default_avatar ] = 'Default Gravatar I chose';
        return $avatar_defaults;
    }
    add_filter( 'avatar_defaults', 'weplugins_new_gravatar' );
    

Example 2: Modifying Avatar Defaults

Here’s an example of how you can modify the default avatars using the avatar_defaults filter.

    function weplugins_modify_avatar_defaults( $avatar_defaults ) { 
        // Update the $avatar_defaults variable according to your website requirements and return this variable.
        // You can modify the $avatar_defaults variable conditionally too if you want.
        return $avatar_defaults; 
    }
    // Add the filter
    add_filter( 'avatar_defaults', 'weplugins_modify_avatar_defaults', 10, 1 );
    

Example 3: Removing the Avatar Defaults Filter

To remove a hook callback, use the example below.

    remove_filter( 'avatar_defaults', 'weplugins_modify_avatar_defaults', 10, 1 );
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.