avatar_defaults

The avatar_defaults hook in WordPress is a filter hook that allows developers to modify the default avatar options available in the WordPress user interface.

By default, WordPress provides a set of pre-defined avatars that users can select for their profile picture or avatar. The avatar_defaults hook enables developers to customize this list by adding, removing, or modifying the default avatars.

This hook is particularly useful when building a theme or plugin that requires a specific set of avatars to be available to users. It allows you to offer a more personalized and cohesive user experience.

Example Usage:

function custom_avatar_defaults($avatar_defaults) {
    // Add a custom avatar option
    $avatar_defaults['custom-avatar'] = 'Custom Avatar';

    // Modify an existing avatar option
    $avatar_defaults['gravatar_default'] = 'Your Custom Gravatar';

    // Remove an existing avatar option
    unset($avatar_defaults['mystery']);

    return $avatar_defaults;
}
add_filter('avatar_defaults', 'custom_avatar_defaults');

In this example, we define a function called custom_avatar_defaults, which accepts the $avatar_defaults array as a parameter. Inside the function, we perform three actions:

1. We add a new avatar option called "Custom Avatar" to the $avatar_defaults array.
2. We modify the existing "Gravatar Default" avatar option to be called "Your Custom Gravatar".
3. We remove the "Mystery" avatar option from the $avatar_defaults array using the unset() function.

Finally, we use the add_filter() function to attach our custom_avatar_defaults function to the avatar_defaults hook. This ensures that our customizations are applied to the default avatars list.

By utilizing the avatar_defaults hook, you can easily customize the available avatar options in WordPress to match your website’s branding or specific requirements.

Learn More on WordPress.org