is_main_site( int $site_id = null, int $network_id = null ): bool

Parameters

$site_idintoptional

Site ID to test. Defaults to current site.Default: null

$network_idintoptional

Network ID of the network to check for. Defaults to current network.Default: null

Return

bool

True if $site_id is the main site of the network, or if not running Multisite.

Uses · 3

• is_multisite()Determines whether Multisite is enabled.
• get_current_blog_id()Retrieves the current site ID.
• get_main_site_id()Gets the main site ID.

Used by · 19

• WP_Automatic_Updater::run()Kicks off the background update process, looping through all pending updates.
• WP_MS_Sites_List_Table::column_cb()Handles the checkbox column output.
• WP_MS_Sites_List_Table::handle_row_actions()Generates and displays row action links.
• WP_MS_Sites_List_Table::site_states()Determines whether to output comma-separated site states.
• WP_Rewrite::rewrite_rules()Constructs rewrite matches and queries from permalink structure.
• WP_Site_Health_Auto_Updates::test_wp_version_check_attached()Checks if updates are intercepted by a filter.
• _wp_upload_dir()A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
• avoid_blog_page_permalink_collision()Avoids a collision between a site slug and a permalink slug.
• delete_expired_transients()Deletes all expired transients.
• get_dirsize()Gets the size of a directory.
• is_main_blog()Deprecated functionality to determine if the current site is the main site.
• maybe_redirect_404()Corrects 404 redirects when NOBLOGREDIRECT is defined.

Source

View on Trac ↗View on GitHub ↗

6539function is_main_site( $site_id = null, $network_id = null ) {6540	if ( ! is_multisite() ) {6541		return true;6542	}6543 6544	if ( ! $site_id ) {6545		$site_id = get_current_blog_id();6546	}6547 6548	$site_id = (int) $site_id;6549 6550	return get_main_site_id( $network_id ) === $site_id;6551}

History

Introduced in 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 7.1.0 tag, from src/wp-includes/functions.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.