archive_blog

Action Hook

Description

Fires when the 'archived' status is added to a site.

Hook Information

File Location	`wp-includes/ms-site.php` View on GitHub
Hook Type	Action
Line Number	`1222`

Hook Parameters

Type	Name	Description
`int`	`$site_id`	Site ID.

Usage Examples

Basic Usage

<?php
// Hook into archive_blog
add_action('archive_blog', 'my_custom_function', 10, 1);

function my_custom_function($site_id) {
    // Your custom code here
}

Source Code Context

wp-includes/ms-site.php:1222 - How this hook is used in WordPress core

<?php
1217  			 *
1218  			 * @since MU (3.0.0)
1219  			 *
1220  			 * @param int $site_id Site ID.
1221  			 */
1222  			do_action( 'archive_blog', $site_id );
1223  		} else {
1224  
1225  			/**
1226  			 * Fires when the 'archived' status is removed from a site.
1227  			 *

PHP Documentation

<?php
/**
			 * Fires when the 'archived' status is added to a site.
			 *
			 * @since MU (3.0.0)
			 *
			 * @param int $site_id Site ID.
			 */

Quick Info

Hook Type: Action
Parameters: 1
File: wp-includes/ms-site.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.