Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use deactivate_blog action in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
May 4, 2023
5 minutes read

deactivate_blog action

Fires before a network site is deactivated.

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

At WePlugins, we 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 live examples below, we have defined a function execute_on_deactivate_blog_event which takes 1 parameter and registered it using add_action. The first parameter deactivate_blog is the name of the hook, the second parameter execute_on_deactivate_blog_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 deactivate_blog action.

Parameters

    Below, the 1 parameter is required to use this hook.

  • $id : (int) The ID of the site being deactivated.

Live Example 1: Basic Usage

Below is a basic example of how you can use this hook.

    function weplugins_deactivate_blog_basic_example( $id ) {
        if ( 5 == $id ) {
            // Update some option or something
        }
    }
    add_action( 'deactivate_blog', 'weplugins_deactivate_blog_basic_example' );
    

Live Example 2: Custom Functionality

This example demonstrates how to execute custom functionality when this action occurs in WordPress.

    function weplugins_execute_on_deactivate_blog_event($id){
        // You can write code here to be executed when this action occurs.
        // Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // Add the action
    add_action( "deactivate_blog", "weplugins_execute_on_deactivate_blog_event" , 10, 1);
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_action( "deactivate_blog", "weplugins_execute_on_deactivate_blog_event", 10, 1 );
    

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

Access Premium WordPress Plugins

Contact Us

If you’re having any trouble using this hook or need customization, please contact us, and we’d be happy to assist you.

Sandeep Kumar Mishra

Sandeep Kumar Mishra

Sandeep Kumar Mishra writes about WordPress and Artificial Intelligence, offering tips and guides to help you master your website and stay updated with the latest tech trends.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.