How to use get_comment_excerpt filter in WordPress

get_comment_excerpt filter

Filters the retrieved comment excerpt.

To use get_comment_excerpt 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 modify_get_comment_excerpt_defaults which takes 3 parameters and we registered using add_filter. The first parameter get_comment_excerpt is the name of the hook, the second parameter modify_get_comment_excerpt_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_comment_excerpt filter.

Parameters

Below are the 3 parameters required to use this hook.

• $excerpt : (string) The comment excerpt text.
• $comment_ID : (string) The comment ID as a numeric string.
• $comment : (WP_Comment) The comment object.

Live Example 1: Basic Usage

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

    function weplugins_modify_get_comment_excerpt_defaults($excerpt, $comment_ID, $comment) { 
        // Update the $excerpt variable according to your website requirements and return this variable. 
        // You can modify the $excerpt variable conditionally too if you want.
        return $excerpt; 
    }
    // add the filter
    add_filter( "get_comment_excerpt", "weplugins_modify_get_comment_excerpt_defaults", 10, 3 );
    

Live Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "get_comment_excerpt", "weplugins_modify_get_comment_excerpt_defaults", 10, 3 );
    

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

Live Example 3: Conditional Modification

Here’s an example of modifying the excerpt based on certain conditions.

    function weplugins_conditional_modify_get_comment_excerpt($excerpt, $comment_ID, $comment) { 
        // Example condition: If comment ID is odd, append a text
        if ($comment_ID % 2 !== 0) {
            $excerpt .= ' - This is an odd comment!';
        }
        return $excerpt; 
    }
    // add the filter
    add_filter( "get_comment_excerpt", "weplugins_conditional_modify_get_comment_excerpt", 10, 3 );
    

Contact Us

If you need any customization or are having trouble using this hook, please contact us. We’re here to help!