wp_uninitialize_site( int|WP_Site $site_id ): true|WP_Error

Description

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|WP_Site

Site ID or object.

Return value

true|WP_Error

True on success, or error object on failure.

Performance profile

How much work a call to wp_uninitialize_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 get_users().

Scaling

Scales with input

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

Instructions

12–90

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

Plugin surface

2 hooks

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_users()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_switch_to_blog()one call below wp_uninitialize_site()

Further down the call graph this can also reach option, serialize 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_uninitialize_site() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_uninitialize_site() runs, in this order:

1. 1
   apply_filters( wpmu_drop_tables )filterline 832 (+48 into the body)

   Filters the tables to drop when the site is deleted.

2. 2
   apply_filters( wpmu_delete_blog_upload_dir )filterline 846 (+62 into the body)

   Filters the upload base directory to delete when the site is deleted.

Uses · 11

• __()Retrieves the translation of $text.
• get_site()Retrieves site data given a site ID or site object.
• wp_is_site_initialized()Checks whether a site is initialized.
• get_users()Retrieves list of users matching criteria.
• remove_user_from_blog()Removes a user from a blog.
• get_current_blog_id()Retrieves the current site ID.
• switch_to_blog()Switches the current blog.
• wp_get_upload_dir()Retrieves uploads directory information.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• restore_current_blog()Restores the current blog, after calling switch_to_blog().
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

784function wp_uninitialize_site( $site_id ) {785	global $wpdb;786 787	if ( empty( $site_id ) ) {788		return new WP_Error( 'site_empty_id', __( 'Site ID must not be empty.' ) );789	}790 791	$site = get_site( $site_id );792	if ( ! $site ) {793		return new WP_Error( 'site_invalid_id', __( 'Site with the ID does not exist.' ) );794	}795 796	if ( ! wp_is_site_initialized( $site ) ) {797		return new WP_Error( 'site_already_uninitialized', __( 'The site appears to be already uninitialized.' ) );798	}799 800	$users = get_users(801		array(802			'blog_id' => $site->id,803			'fields'  => 'ids',804		)805	);806 807	// Remove users from the site.808	if ( ! empty( $users ) ) {809		foreach ( $users as $user_id ) {810			remove_user_from_blog( $user_id, $site->id );811		}812	}813 814	$switch = false;815	if ( get_current_blog_id() !== $site->id ) {816		$switch = true;817		switch_to_blog( $site->id );818	}819 820	$uploads = wp_get_upload_dir();821 822	$tables = $wpdb->tables( 'blog' );823 824	/**825	 * Filters the tables to drop when the site is deleted.826	 *827	 * @since MU (3.0.0)828	 *829	 * @param string[] $tables  Array of names of the site tables to be dropped.830	 * @param int      $site_id The ID of the site to drop tables for.831	 */832	$drop_tables = apply_filters( 'wpmu_drop_tables', $tables, $site->id );833 834	foreach ( (array) $drop_tables as $table ) {835		$wpdb->query( "DROP TABLE IF EXISTS `$table`" ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared836	}837 838	/**839	 * Filters the upload base directory to delete when the site is deleted.840	 *841	 * @since MU (3.0.0)842	 *843	 * @param string $basedir Uploads path without subdirectory. See {@see wp_upload_dir()}.844	 * @param int    $site_id The site ID.845	 */846	$dir     = apply_filters( 'wpmu_delete_blog_upload_dir', $uploads['basedir'], $site->id );847	$dir     = rtrim( $dir, DIRECTORY_SEPARATOR );848	$top_dir = $dir;849	$stack   = array( $dir );850	$index   = 0;851 852	while ( $index < count( $stack ) ) {853		// Get indexed directory from stack.854		$dir = $stack[ $index ];855 856		// phpcs:disable WordPress.PHP.NoSilencedErrors.Discouraged857		$dh = @opendir( $dir );858		if ( $dh ) {859			$file = @readdir( $dh );860			while ( false !== $file ) {861				if ( '.' === $file || '..' === $file ) {862					$file = @readdir( $dh );863					continue;

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.