How to use ms_site_check filter in WordPress

ms_site_check filter

Filters checking the status of the current blog.

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

Sometime, you have to remove a registered hook so you can use remove_filter to remove ms_site_check filter.

Parameters

Below the 1 parameter is required to use this hook.

• $check : (bool|null) Whether to skip the blog status check. Default null.

Live Example

apply_filters( 'ms_site_check', bool|null $check )

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

Example 1: Basic Usage

This example demonstrates the basic usage of the ms_site_check filter.

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

Example 2: Conditional Check

This example shows how you could modify the check conditionally.

    function weplugins_modify_ms_site_check_conditionally($check) { 
        if (some_condition()) {
            $check = true;
        } else {
            $check = false;
        }
        return $check; 
    }
    // add the filter
    add_filter( "ms_site_check", "weplugins_modify_ms_site_check_conditionally", 10, 1 );
    

Example 3: Removing the Filter

To remove a hook callback, use the example below.

    remove_filter( "ms_site_check", "weplugins_modify_ms_site_check_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.