How to use generate_rewrite_rules filter in WordPress

generate_rewrite_rules filter

Fires after the rewrite rules are generated.

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

Parameters

Below the 1 parameter is required to use this hook.

• $wp_rewrite: (WP_Rewrite) Current WP_Rewrite instance (passed by reference).

Live Examples

Example 1: Adding Custom Endpoint

In this example, we add custom endpoints to the rewrite rules.

    function weplugins_site_custom_endpoint( $wp_rewrite ) {
        $feed_rules = array(
            'my-account/?$' => 'index.php?account-page=true',
            'my-account/edit-profile/?$' => 'index.php?account-edit-profile=true',
        );
        $wp_rewrite->rules = $feed_rules + $wp_rewrite->rules;
        return $wp_rewrite->rules;
    }
    add_filter( 'generate_rewrite_rules', 'weplugins_site_custom_endpoint' );
    

Example 2: Modifying Rewrite Rules Defaults

This example shows how you can modify the $wp_rewrite variable according to your website requirements.

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

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "generate_rewrite_rules", "weplugins_modify_generate_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 our WordPress Development Team and we’d be happy to assist you.