How to use comments_rewrite_rules filter in WordPress

comments_rewrite_rules filter

Likely comments feed archives include /comments/feed/ and /comments/feed/atom/.

To use the comments_rewrite_rules filter, first you have to register it using add_filter. You can write this code into the functions.php file of your activated theme or in a custom WordPress Plugin.

At WePlugins, we 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_comments_rewrite_rules_defaults which takes 1 parameter and we registered it using add_filter. The first parameter comments_rewrite_rules is the name of the hook, the second parameter weplugins_modify_comments_rewrite_rules_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 comments_rewrite_rules filter.

Parameters

Below the 1 parameter is required to use this hook.

• $comments_rewrite: (string[]) Array of rewrite rules for the site-wide comments feeds, keyed by their regex pattern.

Live Example

apply_filters( 'comments_rewrite_rules', string[] $comments_rewrite )

Example 1: Basic Hook Implementation

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

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

Example 2: Conditional Modification

In this example, the rewrite rules are modified conditionally based on certain criteria.

    function weplugins_modify_comments_rewrite_rules_defaults($comments_rewrite) { 
        if (is_singular('post')) {
            // Modify rewrite rules for singular posts
            $comments_rewrite['some_pattern'] = 'index.php?feed=rss2';
        }
        return $comments_rewrite; 
    }
    // Add the filter
    add_filter( "comments_rewrite_rules", "weplugins_modify_comments_rewrite_rules_defaults", 10, 1 );
    

Example 3: Removing the Hook Callback

To remove a hook callback, use the example below.

    // Remove the filter
    remove_filter( "comments_rewrite_rules", "weplugins_modify_comments_rewrite_rules_defaults", 10, 1 );
    

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

Contact Us

If you’re having any trouble using this hook, please Contact Us and we’d be happy to assist you.