How to use archive_blog action in WordPress

archive_blog action

Fires when the ‘archived’ status is added to a site.

To use the archive_blog action, first you have to register it using add_action. You can place 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 live examples below, we have defined a function weplugins_execute_on_archive_blog_event which takes 1 parameter and we registered it using add_action. The first parameter archive_blog is the name of the hook, the second parameter weplugins_execute_on_archive_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 to the registered function.

Sometimes, you have to remove a registered hook, so you can use remove_action to remove the archive_blog action.

Parameters

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

• $site_id : (int) Site ID.

Live Example 1

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

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

Live Example 2

To remove a hook callback, use the example below.

        remove_action( "archive_blog", "weplugins_execute_on_archive_blog_event", 10, 1 );
    

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

Live Example 3

Below is another example of how you can use this hook with a different function.

        function weplugins_custom_archive_action($site_id){
           // Custom code to be executed when a site is archived.
        }
        // add the action
        add_action( "archive_blog", "weplugins_custom_archive_action" , 10, 1);
    

Contact Us

If you’re having any trouble using this hook or need customization, please contact us.