How to use pre_get_comments action in WordPress

pre_get_comments action

Fires before comments are retrieved.

To use pre_get_comments action, first you have to register it using add_action. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

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_execute_on_pre_get_comments_event which takes 1 parameter and we registered using add_action. The first parameter pre_get_comments is the name of the hook, the second parameter weplugins_execute_on_pre_get_comments_event 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_action to remove pre_get_comments action.

Parameters

Below the 1 parameter is required to use this hook.

• $query : (WP_Comment_Query) Current instance of WP_Comment_Query (passed by reference).

Live Example 1: Basic Usage

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

    function weplugins_execute_on_pre_get_comments_event($query){
       // You can write code here to be executed when this action occurs in WordPress. Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // add the action
    add_action( "pre_get_comments", "weplugins_execute_on_pre_get_comments_event" , 10, 1);
    

Live Example 2: Removing a Hook

To remove a hook callback, use the example below.

    remove_action( "pre_get_comments", "weplugins_execute_on_pre_get_comments_event", 10, 1 );
    

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

Live Example 3: Conditional Execution

Execute custom actions based on specific conditions.

    function weplugins_custom_pre_get_comments($query){
       if ( is_admin() ) {
           // Modify the query for admin area
       } else {
           // Modify the query for frontend
       }
    }
    add_action( "pre_get_comments", "weplugins_custom_pre_get_comments" , 10, 1);
    

Contact Us

If you need customization or have any trouble using this hook, feel free to contact us.