How to use do_mu_upgrade filter in WordPress

do_mu_upgrade filter

In single site, the user would be redirected to wp-admin/upgrade.php. In multisite, the DB upgrade routine is automatically fired, but only when this filter returns true.

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

Parameters

Below the 1 parameter is required to use this hook.

• $do_mu_upgrade : (bool) Whether to perform the Multisite upgrade routine. Default true.

Live Example 1

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

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

Live Example 2

To remove a hook callback, use the example below.

    remove_filter( "do_mu_upgrade", "weplugins_modify_do_mu_upgrade_defaults", 10, 1 );
    

Live Example 3

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

    remove_filter( "do_mu_upgrade", "weplugins_modify_do_mu_upgrade_defaults", 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.