is_main_site( int $site_id = null, int $network_id = null ): bool
Determines whether a site is the main site of the current network.
Contents
Parameters
-
$site_idint Optional -
Site ID to test. Defaults to current site.
Default:
null -
$network_idint Optional -
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.
More Information
Replaces function is_main_blog(), deprecated since 3.0.0. (wp-includes/ms-deprecated.php)
Source
File: wp-includes/functions.php.
View all references
function is_main_site( $site_id = null, $network_id = null ) {
if ( ! is_multisite() ) {
return true;
}
if ( ! $site_id ) {
$site_id = get_current_blog_id();
}
$site_id = (int) $site_id;
return get_main_site_id( $network_id ) === $site_id;
}
Changelog
| Version | Description |
|---|---|
| 4.9.0 | The $network_id parameter was added. |
| 3.0.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example