{"pageProps":{"title":"wpmu_delete_blog()","titleType":"Function","type":"functions","content":"

wpmu_delete_blog() WordPress Function

The wpmu_delete_blog() function allows you to delete a blog from your WordPress Multisite installation. This function is useful if you want to remove a blog that is no longer active, or if you are cleaning up your Multisite installation.

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

Delete a site.

Contents

Parameters

$blog_id

(int)(Required)Site ID.

$drop

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

Default value: false

Top ↑

Source

File: wp-admin/includes/ms.php

function wpmu_delete_blog( $blog_id, $drop = false ) {\n\tglobal $wpdb;\n\n\t$blog_id = (int) $blog_id;\n\n\t$switch = false;\n\tif ( get_current_blog_id() !== $blog_id ) {\n\t\t$switch = true;\n\t\tswitch_to_blog( $blog_id );\n\t}\n\n\t$blog = get_site( $blog_id );\n\n\t$current_network = get_network();\n\n\t// If a full blog object is not available, do not destroy anything.\n\tif ( $drop && ! $blog ) {\n\t\t$drop = false;\n\t}\n\n\t// Don't destroy the initial, main, or root blog.\n\tif ( $drop\n\t\t&& ( 1 === $blog_id || is_main_site( $blog_id )\n\t\t\t|| ( $blog->path === $current_network->path && $blog->domain === $current_network->domain ) )\n\t) {\n\t\t$drop = false;\n\t}\n\n\t$upload_path = trim( get_option( 'upload_path' ) );\n\n\t// If ms_files_rewriting is enabled and upload_path is empty, wp_upload_dir is not reliable.\n\tif ( $drop && get_site_option( 'ms_files_rewriting' ) && empty( $upload_path ) ) {\n\t\t$drop = false;\n\t}\n\n\tif ( $drop ) {\n\t\twp_delete_site( $blog_id );\n\t} else {\n\t\t/** This action is documented in wp-includes/ms-blogs.php */\n\t\tdo_action_deprecated( 'delete_blog', array( $blog_id, false ), '5.1.0' );\n\n\t\t$users = get_users(\n\t\t\tarray(\n\t\t\t\t'blog_id' => $blog_id,\n\t\t\t\t'fields'  => 'ids',\n\t\t\t)\n\t\t);\n\n\t\t// Remove users from this blog.\n\t\tif ( ! empty( $users ) ) {\n\t\t\tforeach ( $users as $user_id ) {\n\t\t\t\tremove_user_from_blog( $user_id, $blog_id );\n\t\t\t}\n\t\t}\n\n\t\tupdate_blog_status( $blog_id, 'deleted', 1 );\n\n\t\t/** This action is documented in wp-includes/ms-blogs.php */\n\t\tdo_action_deprecated( 'deleted_blog', array( $blog_id, false ), '5.1.0' );\n\t}\n\n\tif ( $switch ) {\n\t\trestore_current_blog();\n\t}\n}\n

Expand full source codeCollapse full source codeView on TracView on GitHub

Top ↑

Related

Top ↑

Uses

Uses
UsesDescription
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()

Retrieves list of users matching criteria.

wp-includes/ms-functions.php:remove_user_from_blog()

Removes 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().

Show 10 more usesHide more uses

Top ↑

Changelog

Changelog
VersionDescription
5.1.0Use wp_delete_site() internally to delete the site row from the database.
3.0.0Introduced.
","description":"Delete a site.","sidebarFiles":{"Function":[{"componentTitle":"avoid_blog_page_permalink_collision()","componentLink":"/reference/functions/avoid_blog_page_permalink_collision","private":"","deprecated":""},{"componentTitle":"can_edit_network()","componentLink":"/reference/functions/can_edit_network","private":"","deprecated":""},{"componentTitle":"check_import_new_users()","componentLink":"/reference/functions/check_import_new_users","private":"","deprecated":""},{"componentTitle":"check_upload_size()","componentLink":"/reference/functions/check_upload_size","private":"","deprecated":""},{"componentTitle":"choose_primary_blog()","componentLink":"/reference/functions/choose_primary_blog","private":"","deprecated":""},{"componentTitle":"confirm_delete_users()","componentLink":"/reference/functions/confirm_delete_users","private":"","deprecated":""},{"componentTitle":"display_space_usage()","componentLink":"/reference/functions/display_space_usage","private":"","deprecated":""},{"componentTitle":"fix_import_form_size()","componentLink":"/reference/functions/fix_import_form_size","private":"","deprecated":""},{"componentTitle":"format_code_lang()","componentLink":"/reference/functions/format_code_lang","private":"","deprecated":""},{"componentTitle":"get_site_screen_help_sidebar_content()","componentLink":"/reference/functions/get_site_screen_help_sidebar_content","private":"","deprecated":""},{"componentTitle":"get_site_screen_help_tab_args()","componentLink":"/reference/functions/get_site_screen_help_tab_args","private":"","deprecated":""},{"componentTitle":"mu_dropdown_languages()","componentLink":"/reference/functions/mu_dropdown_languages","private":"","deprecated":""},{"componentTitle":"network_edit_site_nav()","componentLink":"/reference/functions/network_edit_site_nav","private":"","deprecated":""},{"componentTitle":"network_settings_add_js()","componentLink":"/reference/functions/network_settings_add_js","private":"","deprecated":""},{"componentTitle":"refresh_user_details()","componentLink":"/reference/functions/refresh_user_details","private":"","deprecated":""},{"componentTitle":"site_admin_notice()","componentLink":"/reference/functions/site_admin_notice","private":"","deprecated":""},{"componentTitle":"sync_category_tag_slugs()","componentLink":"/reference/functions/sync_category_tag_slugs","private":"","deprecated":""},{"componentTitle":"upload_is_user_over_quota()","componentLink":"/reference/functions/upload_is_user_over_quota","private":"","deprecated":""},{"componentTitle":"upload_space_setting()","componentLink":"/reference/functions/upload_space_setting","private":"","deprecated":""},{"componentTitle":"wpmu_delete_blog()","componentLink":"/reference/functions/wpmu_delete_blog","private":"","deprecated":"","active":"active"},{"componentTitle":"wpmu_delete_user()","componentLink":"/reference/functions/wpmu_delete_user","private":"","deprecated":""},{"componentTitle":"_access_denied_splash()","componentLink":"/reference/functions/_access_denied_splash","private":"private","deprecated":""},{"componentTitle":"_thickbox_path_admin_subfolder()","componentLink":"/reference/functions/_thickbox_path_admin_subfolder","private":"private","deprecated":""}],"Hook":[{"componentTitle":"can_edit_network","componentLink":"/reference/hooks/can_edit_network","private":"","deprecated":""},{"componentTitle":"lang_codes","componentLink":"/reference/hooks/lang_codes","private":"","deprecated":""},{"componentTitle":"mu_dropdown_languages","componentLink":"/reference/hooks/mu_dropdown_languages","private":"","deprecated":""},{"componentTitle":"network_edit_site_nav_links","componentLink":"/reference/hooks/network_edit_site_nav_links","private":"","deprecated":""},{"componentTitle":"wpmu_delete_user","componentLink":"/reference/hooks/wpmu_delete_user","private":"","deprecated":""}]}},"__N_SSG":true}