How to use ms_site_not_found action in WordPress

So, you’re diving into the ms_site_not_found action hook? Let’s break it down in a friendly, easy-to-understand way. This hook is super useful when you need to redirect somewhere and exit if a specific site is not found. Here’s how you can register and use this action in your WordPress setup, and of course, we’ll throw in some live examples for you!

Examples of ms_site_not_found Action Hook

1. Registering the Hook

To use the ms_site_not_found action, you first need to register it using add_action. This code can be added to your theme’s functions.php file or, better yet, in a custom WordPress Plugin to avoid issues when updating your theme. Check out the code snippet below:

    function weplugins_execute_on_ms_site_not_found_event($current_site, $domain, $path){
       // Code to execute when this action occurs
    }
    // Add the action
    add_action("ms_site_not_found", "weplugins_execute_on_ms_site_not_found_event", 10, 3);
    

2. Removing the Hook

Sometimes, you may need to remove a registered hook. You can use remove_action to remove the ms_site_not_found action. Here’s how you can do it:

    remove_action("ms_site_not_found", "weplugins_execute_on_ms_site_not_found_event", 10, 3);
    

Remember to provide the same callback function name, priority, and number of arguments when removing the hook callback.

3. Using the Hook

Here’s a simple example of how you can use the ms_site_not_found hook to execute custom functionality when a site is not found:

    function weplugins_execute_on_ms_site_not_found_event($current_site, $domain, $path){
       // Implement custom functionality here
       // Use the parameters $current_site, $domain, and $path as needed
    }
    // Add the action
    add_action("ms_site_not_found", "weplugins_execute_on_ms_site_not_found_event", 10, 3);
    

Parameters

Below are the 3 parameters required to use this hook:

• $current_site: (WP_Network) The network that had been determined.
• $domain: (string) The domain used to search for a site.
• $path: (string) The path used to search for a site.