How to use comment_excerpt_length filter in WordPress

comment_excerpt_length filter

Filters the maximum number of words used in the comment excerpt.

To use the comment_excerpt_length 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 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 weplugins_modify_comment_excerpt_length_defaults which takes 1 parameter and we registered using add_filter. The first parameter comment_excerpt_length is the name of the hook, the second parameter weplugins_modify_comment_excerpt_length_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 comment_excerpt_length filter.

Parameters

Below the 1 parameter is required to use this hook.

• $comment_excerpt_length : (int) The amount of words you want to display in the comment excerpt.

Live Example

Applying the Filter

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

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

Removing the Filter

To remove a hook callback, use the example below.

        remove_filter( "comment_excerpt_length", "weplugins_modify_comment_excerpt_length_defaults", 10, 1 );
    

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

Another Example

Here is another scenario where you might want to conditionally change the comment excerpt length.

        function weplugins_modify_comment_excerpt_length_conditional($comment_excerpt_length) { 
            if ( is_admin() ) {
                return 10; // Shorter excerpts for admin area
            }
            return $comment_excerpt_length; 
        }
        // add the filter
        add_filter( "comment_excerpt_length", "weplugins_modify_comment_excerpt_length_conditional", 10, 1 );
    

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.