How to use ms_loaded action in WordPress

ms_loaded action

Fires after the current site and network have been detected and loaded in multisite’s bootstrap.

To use the ms_loaded action, first you have to register it using add_action. 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 execute_on_ms_loaded_event and we registered it using add_action. The first parameter ms_loaded is the name of the hook, the second parameter execute_on_ms_loaded_event 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_action to remove the ms_loaded action.

Parameters

• No parameters

Live Example 1

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

    function weplugins_execute_on_ms_loaded_event(){
        // You can write code here to be executed when this action occurs in WordPress website according to your requirements.
    }
    // Add the action
    add_action( "ms_loaded", "weplugins_execute_on_ms_loaded_event" );
    

Live Example 2

To remove a hook callback, use the example below.

    remove_action( "ms_loaded", "weplugins_execute_on_ms_loaded_event" );
    

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

Live Example 3

Another example to demonstrate the versatility of this hook.

    function weplugins_custom_ms_loaded_action(){
        // Custom functionality to be executed during ms_loaded event
        error_log("Multisite loaded successfully.");
    }
    // Add the custom action
    add_action( "ms_loaded", "weplugins_custom_ms_loaded_action" );
    

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.