How to use flush_rewrite_rules_hard filter in WordPress

flush_rewrite_rules_hard filter

A “hard” flush updates .htaccess (Apache) or web.config (IIS).

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

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 weplugins_modify_flush_rewrite_rules_hard_defaults which takes 1 parameter and we registered using add_filter. The first parameter flush_rewrite_rules_hard is the name of the hook, the second parameter weplugins_modify_flush_rewrite_rules_hard_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 flush_rewrite_rules_hard filter.

Parameters

Below the 1 parameter is required to use this hook.

• $hard : (bool) Whether to flush rewrite rules “hard”. Default true.

Live Example

apply_filters( 'flush_rewrite_rules_hard', bool $hard )

Example 1: Basic Usage

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

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

Example 2: Removing the Hook

To remove a hook callback, use the example below.

    // remove the filter
    remove_filter( "flush_rewrite_rules_hard", "weplugins_modify_flush_rewrite_rules_hard_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, we modify the $hard variable conditionally based on some criteria.

    function weplugins_modify_flush_rewrite_rules_hard_conditionally($hard) { 
        if (some_condition()) {
            $hard = false;
        }
        return $hard; 
    }
    // add the filter
    add_filter( "flush_rewrite_rules_hard", "weplugins_modify_flush_rewrite_rules_hard_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.