Multisite: Introduce get_main_site_id().

This function can be used to easily get the main site ID of a given network via the optional `$network_id` parameter, which defaults to the current network. The existing `is_main_site()` now uses the new function internally and now accepts an optional `$network_id` parameter as well.

The main purpose of the new function at this point is to ensure that the `WP_Network::$blog_id` property is always set. Magic getters in the class have been adjusted to auto-fill the property when it is accessed and empty. Furthermore the function encapsulates logic that was previously part of `ms_load_current_site_and_network()` and has been replaced with a call to the function now.

Props spacedmonkey, jeremyfelt, johnjamesjacoby, flixos90.
Fixes #29684.


git-svn-id: https://develop.svn.wordpress.org/trunk@41380 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Felix Arntz
2017-09-15 11:14:49 +00:00
parent 95a2632121
commit e23004c344
6 changed files with 249 additions and 15 deletions

View File

@@ -4390,19 +4390,92 @@ function wp_suspend_cache_invalidation( $suspend = true ) {
* Determine whether a site is the main site of the current network.
*
* @since 3.0.0
* @since 4.9.0 The $network_id parameter has been added.
*
* @param int $site_id Optional. Site ID to test. Defaults to current site.
* @param int $site_id Optional. Site ID to test. Defaults to current site.
* @param int $network_id Optional. Network ID of the network to check for.
* Defaults to current network.
* @return bool True if $site_id is the main site of the network, or if not
* running Multisite.
*/
function is_main_site( $site_id = null ) {
if ( ! is_multisite() )
function is_main_site( $site_id = null, $network_id = null ) {
if ( ! is_multisite() ) {
return true;
}
if ( ! $site_id )
if ( ! $site_id ) {
$site_id = get_current_blog_id();
}
return (int) $site_id === (int) get_network()->site_id;
$site_id = (int) $site_id;
return $site_id === get_main_site_id( $network_id );
}
/**
* Gets the main site ID.
*
* @since 4.9.0
*
* @param int $network_id Optional. The ID of the network for which to get the main site.
* Defaults to the current network.
* @return int The ID of the main site.
*/
function get_main_site_id( $network_id = null ) {
if ( ! is_multisite() ) {
return 1;
}
$network = get_network( $network_id );
if ( ! $network ) {
return 0;
}
/**
* Filters the main site ID.
*
* Returning anything other than null will effectively short-circuit the function, returning
* the result parsed as an integer immediately.
*
* @since 4.9.0
*
* @param int|null $main_site_id If anything other than null is returned, it is interpreted as the main site ID.
* @param int $network_id The ID of the network for which the main site was detected.
*/
$main_site_id = apply_filters( 'pre_get_main_site_id', null, $network->id );
if ( null !== $main_site_id ) {
return (int) $main_site_id;
}
if ( ( defined( 'DOMAIN_CURRENT_SITE' ) && defined( 'PATH_CURRENT_SITE' ) && $network->domain === DOMAIN_CURRENT_SITE && $network->path === PATH_CURRENT_SITE )
|| ( defined( 'SITE_ID_CURRENT_SITE' ) && $network->id == SITE_ID_CURRENT_SITE ) ) {
if ( defined( 'BLOG_ID_CURRENT_SITE' ) ) {
return BLOG_ID_CURRENT_SITE;
} elseif ( defined( 'BLOGID_CURRENT_SITE' ) ) { // deprecated.
return BLOGID_CURRENT_SITE;
}
}
$site = get_site();
if ( $site->domain === $network->domain && $site->path === $network->path ) {
$main_site_id = (int) $site->id;
} else {
$main_site_id = wp_cache_get( 'network:' . $network->id . ':main_site', 'site-options' );
if ( false === $main_site_id ) {
$_sites = get_sites( array(
'fields' => 'ids',
'number' => 1,
'domain' => $network->domain,
'path' => $network->path,
'network_id' => $network->id,
) );
$main_site_id = ! empty( $_sites ) ? array_shift( $_sites ) : 0;
wp_cache_add( 'network:' . $network->id . ':main_site', $main_site_id, 'site-options' );
}
}
return (int) $main_site_id;
}
/**