How to use default_avatar_select filter in WordPress

default_avatar_select filter

Filters the HTML output of the default avatar list.

To use the default_avatar_select 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.

WePlugins always prefers 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 `weplugins_modify_default_avatar_select_defaults` which takes 1 parameter and we registered using add_filter. The first parameter `default_avatar_select` is the name of the hook, the second parameter `weplugins_modify_default_avatar_select_defaults` is the name of the function which 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 default_avatar_select filter.

Parameters

Below the 1 parameter is required to use this hook.

• $avatar_list : (string) HTML markup of the avatar list.

Live Example

apply_filters( 'default_avatar_select', string $avatar_list )

Below is an example of how you can use this hook.

Example 1: Basic Usage

In this example, we modify the avatar list to fit our website’s requirements.

    function weplugins_modify_default_avatar_select_defaults($avatar_list) { 
        // Update the $avatar_list variable according to your website requirements and return this variable.
        // You can modify the $avatar_list variable conditionally too if you want.
        return $avatar_list; 
    }
    // add the filter
    add_filter( "default_avatar_select", "weplugins_modify_default_avatar_select_defaults", 10, 1 );
    

Example 2: Conditional Modification

Here, we conditionally modify the avatar list based on a certain criterion.

    function weplugins_modify_default_avatar_select_defaults($avatar_list) {
        if ( is_user_logged_in() ) {
            // Modify the avatar list for logged-in users.
            $avatar_list .= '<img src="path/to/custom/avatar.png" alt="Custom Avatar">';
        }
        return $avatar_list; 
    }
    // add the filter
    add_filter( "default_avatar_select", "weplugins_modify_default_avatar_select_defaults", 10, 1 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "default_avatar_select", "weplugins_modify_default_avatar_select_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 need customization or are having any trouble using this hook, please contact us. We’d be happy to assist you.