wp_delete_site( int $site_id ): WP_Site|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$site_idint

ID of the site that should be deleted.

Return value

WP_Site|WP_Error

The deleted site object on success, or error object on failure.

Performance profile

How much work a call to wp_delete_site() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->delete().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

12–77

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 110.

Plugin surface

5 hooks

Third-party callbacks on 'wp_validate_site_deletion', 'delete_blog', 'wp_uninitialize_site' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()called directly
• sqldatabase query->delete()called directly
• optionnetwork optionget_network_option()one call below wp_delete_site()
• cacheobject cachewp_cache_delete()one call below wp_delete_site()

Further down the call graph this can also reach serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 7 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_delete_site() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 5

5 hooks fire while wp_delete_site() runs, in this order:

1. 1
   do_action( wp_validate_site_deletion )actionline 237 (+25 into the body)

   Fires before a site should be deleted from the database.

2. 2
   do_action( delete_blog )action_deprecatedline 252 (+40 into the body)

   Fires before a site is deleted.

3. 3
   do_action( wp_uninitialize_site )actionline 261 (+49 into the body)

   Fires when a site's uninitialization routine should be executed.

4. 4
   do_action( wp_delete_site )actionline 283 (+71 into the body)

   Fires once a site has been deleted from the database.

5. 5
   do_action( deleted_blog )action_deprecatedline 294 (+82 into the body)

   Fires after the site is deleted from the network.

Uses · 8

• __()Retrieves the translation of $text.
• get_site()Retrieves site data given a site ID or site object.
• do_action()Calls the callback functions that have been added to an action hook.
• do_action_deprecated()Fires functions attached to a deprecated action hook.
• is_site_meta_supported()Determines whether site meta is enabled.
• delete_metadata_by_mid()Deletes metadata by meta ID.
• clean_blog_cache()Clean the blog cache
• WP_Error::__construct()Initializes the error.

Used by · 1

• wpmu_delete_blog()Deletes a site.

Source code

View on Trac ↗View on GitHub ↗

212function wp_delete_site( $site_id ) {213	global $wpdb;214 215	if ( empty( $site_id ) ) {216		return new WP_Error( 'site_empty_id', __( 'Site ID must not be empty.' ) );217	}218 219	$old_site = get_site( $site_id );220	if ( ! $old_site ) {221		return new WP_Error( 'site_not_exist', __( 'Site does not exist.' ) );222	}223 224	$errors = new WP_Error();225 226	/**227	 * Fires before a site should be deleted from the database.228	 *229	 * Plugins should amend the `$errors` object via its `WP_Error::add()` method. If any errors230	 * are present, the site will not be deleted.231	 *232	 * @since 5.1.0233	 *234	 * @param WP_Error $errors   Error object to add validation errors to.235	 * @param WP_Site  $old_site The site object to be deleted.236	 */237	do_action( 'wp_validate_site_deletion', $errors, $old_site );238 239	if ( ! empty( $errors->errors ) ) {240		return $errors;241	}242 243	/**244	 * Fires before a site is deleted.245	 *246	 * @since MU (3.0.0)247	 * @deprecated 5.1.0248	 *249	 * @param int  $site_id The site ID.250	 * @param bool $drop    True if site's table should be dropped. Default false.251	 */252	do_action_deprecated( 'delete_blog', array( $old_site->id, true ), '5.1.0' );253 254	/**255	 * Fires when a site's uninitialization routine should be executed.256	 *257	 * @since 5.1.0258	 *259	 * @param WP_Site $old_site Deleted site object.260	 */261	do_action( 'wp_uninitialize_site', $old_site );262 263	if ( is_site_meta_supported() ) {264		$blog_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->blogmeta WHERE blog_id = %d ", $old_site->id ) );265		foreach ( $blog_meta_ids as $mid ) {266			delete_metadata_by_mid( 'blog', $mid );267		}268	}269 270	if ( false === $wpdb->delete( $wpdb->blogs, array( 'blog_id' => $old_site->id ) ) ) {271		return new WP_Error( 'db_delete_error', __( 'Could not delete site from the database.' ), $wpdb->last_error );272	}273 274	clean_blog_cache( $old_site );275 276	/**277	 * Fires once a site has been deleted from the database.278	 *279	 * @since 5.1.0280	 *281	 * @param WP_Site $old_site Deleted site object.282	 */283	do_action( 'wp_delete_site', $old_site );284 285	/**286	 * Fires after the site is deleted from the network.287	 *288	 * @since 4.8.0289	 * @deprecated 5.1.0290	 *291	 * @param int  $site_id The site ID.

Changelog

Introduced in 5.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/ms-site.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.