How to use avatar_defaults filter in WordPress

avatar_defaults filter

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

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

We at Flipper Code, 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 parameters and we registered using add_filter. The first parameter avatar_defaults is name of the hook, The second parameter modify_avatar_defaults_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

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

Parameters

Below the 1 parameter is required to use this hook.

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

Live Example

function wpdocs_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', 'wpdocs_new_gravatar' );

Below is an example how you can use this hook.

                        function modify_avatar_defaults_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", "modify_avatar_defaults_defaults", 10, 1 );

To remove a hook callback, use the example below.

remove_filter( "avatar_defaults", "modify_avatar_defaults_defaults", 10, 1 );

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

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.