How to use get_avatar_comment_types filter in WordPress

get_avatar_comment_types filter

Filters the list of allowed comment types for retrieving avatars.

To use get_avatar_comment_types filter, first you have 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_get_avatar_comment_types_defaults which takes 1 parameter and we registered using add_filter. The first parameter get_avatar_comment_types is the name of the hook, The second parameter modify_get_avatar_comment_types_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.

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

Parameters

Below the 1 parameter is required to use this hook.

• $types : (array) An array of content types. Default only contains ‘comment’.

Live Example

apply_filters( 'get_avatar_comment_types', array $types )

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

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

Example 1: Adding Custom Comment Types

This example demonstrates how to add custom comment types to the avatar filter.

        function weplugins_add_custom_comment_types($types) {
            $types[] = 'custom_type';
            return $types;
        }
        add_filter('get_avatar_comment_types', 'weplugins_add_custom_comment_types', 10, 1);
    

Example 2: Modifying Existing Comment Types

This example shows how to modify existing comment types.

        function weplugins_modify_existing_comment_types($types) {
            if(in_array('comment', $types)) {
                $types = array_diff($types, array('comment'));
                $types[] = 'custom_comment';
            }
            return $types;
        }
        add_filter('get_avatar_comment_types', 'weplugins_modify_existing_comment_types', 10, 1);
    

Example 3: Removing Custom Comment Types

This example demonstrates how to remove previously added custom comment types.

        function weplugins_remove_custom_comment_types($types) {
            $types = array_filter($types, function($type) {
                return $type !== 'custom_type';
            });
            return $types;
        }
        add_filter('get_avatar_comment_types', 'weplugins_remove_custom_comment_types', 10, 1);
    

To remove a hook callback, use the example below.

remove_filter( "get_avatar_comment_types", "weplugins_modify_get_avatar_comment_types_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 have any trouble using this hook, please contact us and we’d be happy to assist you.