switch_to_blog( int $new_blog_id, bool $deprecated = null ): true

Description

Parameters

$new_blog_idint

The ID of the blog to switch to. Default: current blog.

$deprecatedbooloptional

Not used.Default: null

Return

true

Always returns true.

Hooks fired · 2

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

1. 1
   do_action( switch_blog )actionline 527 (+27 into the body)

   Fires when the blog is switched.

2. 2
   do_action( switch_blog )actionline 587 (+87 into the body)

   Fires when the blog is switched.

Uses · 6

• get_current_blog_id()Retrieves the current site ID.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_cache_switch_to_blog()Switches the internal blog ID.
• wp_cache_init()Sets up Object Cache Global and assigns it.
• wp_cache_add_global_groups()Adds a group or set of groups to the list of global groups.
• wp_cache_add_non_persistent_groups()Adds a group or set of groups to the list of non-persistent groups.

Used by · 37

• WP_Importer::set_blog()
• WP_MS_Sites_List_Table::column_blogname()Handles the site name column output.
• WP_Site::get_details()Retrieves the details for this site.
• WP_Theme::get_allowed_on_site()Returns array of stylesheet names of themes allowed on the site.
• WP_User::get_role_caps()Retrieves all of the capabilities of the user's roles, and merges them with individual user capabilities.
• WP_User_Query::get_cache_last_changed()Retrieves the last changed cache timestamp for users and optionally posts.
• WP_Users_List_Table::get_views()Returns an associative array listing all the views that can be used with this table.
• add_blog_option()Adds a new option for a given blog ID.
• add_user_to_blog()Adds a user to a blog, along with specifying the user's role.
• confirm_another_blog_signup()Shows a message confirming that the new site has been created.
• count_users()Counts number of users who have each of the user roles.
• create_empty_blog()Create an empty blog.

Source

View on Trac ↗View on GitHub ↗

500function switch_to_blog( $new_blog_id, $deprecated = null ) {501	global $wpdb;502 503	$prev_blog_id = get_current_blog_id();504	if ( empty( $new_blog_id ) ) {505		$new_blog_id = $prev_blog_id;506	}507 508	$GLOBALS['_wp_switched_stack'][] = $prev_blog_id;509 510	/*511	 * If we're switching to the same blog id that we're on,512	 * set the right vars, do the associated actions, but skip513	 * the extra unnecessary work514	 */515	if ( $new_blog_id === $prev_blog_id ) {516		/**517		 * Fires when the blog is switched.518		 *519		 * @since MU (3.0.0)520		 * @since 5.4.0 The `$context` parameter was added.521		 *522		 * @param int    $new_blog_id  New blog ID.523		 * @param int    $prev_blog_id Previous blog ID.524		 * @param string $context      Additional context. Accepts 'switch' when called from switch_to_blog()525		 *                             or 'restore' when called from restore_current_blog().526		 */527		do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'switch' );528 529		$GLOBALS['switched'] = true;530 531		return true;532	}533 534	$wpdb->set_blog_id( $new_blog_id );535	$GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();536	$GLOBALS['blog_id']      = $new_blog_id;537 538	if ( function_exists( 'wp_cache_switch_to_blog' ) ) {539		wp_cache_switch_to_blog( $new_blog_id );540	} else {541		global $wp_object_cache;542 543		if ( is_object( $wp_object_cache ) && isset( $wp_object_cache->global_groups ) ) {544			$global_groups = $wp_object_cache->global_groups;545		} else {546			$global_groups = false;547		}548 549		wp_cache_init();550 551		if ( function_exists( 'wp_cache_add_global_groups' ) ) {552			if ( is_array( $global_groups ) ) {553				wp_cache_add_global_groups( $global_groups );554			} else {555				wp_cache_add_global_groups(556					array(557						'blog-details',558						'blog-id-cache',559						'blog-lookup',560						'blog_meta',561						'global-posts',562						'image_editor',563						'networks',564						'network-queries',565						'sites',566						'site-details',567						'site-options',568						'site-queries',569						'site-transient',570						'theme_files',571						'rss',572						'users',573						'user-queries',574						'user_meta',575						'useremail',576						'userlogins',577						'userslugs',578					)579				);

History

Introduced in MU (3.0.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-blogs.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.