How to use get_comment filter in WordPress

get_comment filter

Fires after a comment is retrieved.

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

Parameters

Below the 1 parameter is required to use this hook.

• $_comment : (WP_Comment) Comment data.

Live Examples

Example 1: Basic Usage

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

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

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "get_comment", "weplugins_modify_get_comment_defaults", 10, 1 );
    

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

Example 3: Conditional Modification

In this example, the comment data is modified based on certain conditions.

    function weplugins_modify_get_comment_conditionally($_comment) {
        // Check some conditions and modify $_comment accordingly
        if ($_comment->comment_approved == '1') {
            $_comment->comment_content .= ' - Approved';
        }
        return $_comment;
    }
    // add the filter
    add_filter( "get_comment", "weplugins_modify_get_comment_conditionally", 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.