How to use comment_feed_orderby filter in WordPress

comment_feed_orderby filter

Filters the ORDER BY clause of the comments feed query before sending.

To use the comment_feed_orderby 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.

It’s always a good practice 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_feed_orderby_defaults which takes 2 parameters and we registered it using add_filter. The first parameter comment_feed_orderby is the name of the hook, the second parameter weplugins_modify_comment_feed_orderby_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_feed_orderby filter.

Parameters

Below are the 2 parameters required to use this hook.

• $corderby : (string) The ORDER BY clause of the query.
• $query : (WP_Query) The WP_Query instance (passed by reference).

Live Example

apply_filters_ref_array( 'comment_feed_orderby', string $corderby, WP_Query $query )

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

Example 1: Basic Usage

Use this example to modify the ORDER BY clause of the comments feed query.

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

Example 2: Removing the Hook

To remove a hook callback, use the example below.

remove_filter( "comment_feed_orderby", "weplugins_modify_comment_feed_orderby_defaults", 10, 2 );

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

Example 3: Conditional Modification

Conditionally modify the ORDER BY clause based on a specific condition.

    function weplugins_conditional_comment_feed_orderby($corderby, $query) { 
        if ( some_condition() ) {
            $corderby = 'comment_date_gmt DESC';
        }
        return $corderby;
    }
    // add the filter
    add_filter( "comment_feed_orderby", "weplugins_conditional_comment_feed_orderby", 10, 2 );
    

Contact Us

If you’re having any trouble using this hook or need customization, please contact our WordPress Development Team and we’d be happy to assist you.