W3cubDocs

/WordPress

wpmu_delete_blog( int $blog_id, bool $drop = false )

Delete a site.

Parameters

$blog_id

(int) (Required) Site ID.

$drop

(bool) (Optional) True if site's database tables should be dropped.

Default value: false

Source

File: wp-admin/includes/ms.php 

function wpmu_delete_blog( $blog_id, $drop = false ) {
	global $wpdb;

	$switch = false;
	if ( get_current_blog_id() != $blog_id ) {
		$switch = true;
		switch_to_blog( $blog_id );
	}

	$blog = get_site( $blog_id );

	$current_network = get_network();

	// If a full blog object is not available, do not destroy anything.
	if ( $drop && ! $blog ) {
		$drop = false;
	}

	// Don't destroy the initial, main, or root blog.
	if ( $drop && ( 1 == $blog_id || is_main_site( $blog_id ) || ( $blog->path == $current_network->path && $blog->domain == $current_network->domain ) ) ) {
		$drop = false;
	}

	$upload_path = trim( get_option( 'upload_path' ) );

	// If ms_files_rewriting is enabled and upload_path is empty, wp_upload_dir is not reliable.
	if ( $drop && get_site_option( 'ms_files_rewriting' ) && empty( $upload_path ) ) {
		$drop = false;
	}

	if ( $drop ) {
		wp_delete_site( $blog_id );
	} else {
		/** This action is documented in wp-includes/ms-blogs.php */
		do_action_deprecated( 'delete_blog', array( $blog_id, false ), '5.1.0' );

		$users = get_users(
			array(
				'blog_id' => $blog_id,
				'fields'  => 'ids',
			)
		);

		// Remove users from this blog.
		if ( ! empty( $users ) ) {
			foreach ( $users as $user_id ) {
				remove_user_from_blog( $user_id, $blog_id );
			}
		}

		update_blog_status( $blog_id, 'deleted', 1 );

		/** This action is documented in wp-includes/ms-blogs.php */
		do_action_deprecated( 'deleted_blog', array( $blog_id, false ), '5.1.0' );
	}

	if ( $switch ) {
		restore_current_blog();
	}
}

Uses

Uses Description
wp-includes/ms-site.php: wp_delete_site()

Deletes a site from the database.
wp-includes/ms-site.php: deleted_blog

Fires after the site is deleted from the network.
wp-includes/ms-network.php: get_network()

Retrieves network data given a network ID or network object.
wp-includes/ms-site.php: get_site()

Retrieves site data given a site ID or site object.
wp-includes/plugin.php: do_action_deprecated()

Fires functions attached to a deprecated action hook.
wp-includes/ms-site.php: delete_blog

Fires before a site is deleted.
wp-includes/load.php: get_current_blog_id()

Retrieve the current site ID.
wp-includes/functions.php: is_main_site()

Determine whether a site is the main site of the current network.
wp-includes/option.php: get_site_option()

Retrieve an option value for the current network based on name of option.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/user.php: get_users()

Retrieve list of users matching criteria.
wp-includes/ms-functions.php: remove_user_from_blog()

Remove a user from a blog.
wp-includes/ms-blogs.php: switch_to_blog()

Switch the current blog.
wp-includes/ms-blogs.php: update_blog_status()

Update a blog details field.
wp-includes/ms-blogs.php: restore_current_blog()

Restore the current blog, after calling switch_to_blog().

Changelog

Version Description
5.1.0 Use wp_delete_site() internally to delete the site row from the database.
3.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wpmu_delete_blog