Multisite: Lazy load extended WP_Site properties when requested.

In the past, `get_blog_details()` has been used to retrieve the `home`, `siteurl`, `blogname`, and `post_count` options for a site. By lazy loading properties in a `WP_Site` object, we can avoid having to use `get_blog_details()` and instead provide the properties as needed.

This introduces the global `site-details` cache group in which standard objects representing the site are stored. This will one day be a replacement for the `blog-details` cache group that is currently used in `get_blog_details()`.

This relies on the `ms_loaded` action introduced in [37916] as properties are not available via `get_option()` until multisite has been fully loaded.

Props flixos90.
Fixes #36935.


git-svn-id: https://develop.svn.wordpress.org/trunk@37918 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jeremy Felt
2016-06-29 19:31:49 +00:00
parent 194f176c8b
commit fbe1dc18d0
3 changed files with 77 additions and 3 deletions
+73
View File
@@ -222,6 +222,7 @@ final class WP_Site {
* Getter.
*
* Allows current multisite naming conventions when getting properties.
* Allows access to extended site properties.
*
* @since 4.6.0
* @access public
@@ -239,6 +240,15 @@ final class WP_Site {
return $this->site_id;
case 'network_id':
return (int) $this->site_id;
case 'blogname':
case 'siteurl':
case 'post_count':
case 'home':
if ( ! did_action( 'ms_loaded' ) ) {
return null;
}
$details = $this->get_details();
return $details->$key;
}
return null;
@@ -248,6 +258,7 @@ final class WP_Site {
* Isset-er.
*
* Allows current multisite naming conventions when checking for properties.
* Checks for extended site properties.
*
* @since 4.6.0
* @access public
@@ -262,6 +273,14 @@ final class WP_Site {
case 'site_id':
case 'network_id':
return true;
case 'blogname':
case 'siteurl':
case 'post_count':
case 'home':
if ( ! did_action( 'ms_loaded' ) ) {
return false;
}
return true;
}
return false;
@@ -292,4 +311,58 @@ final class WP_Site {
$this->$key = $value;
}
}
/**
* Retrieve the details for this site.
*
* This method is used internally to lazy-load the extended properties of a site.
*
* @since 4.6.0
* @access private
*
* @see WP_Site::__get()
*
* @return object A raw site object with all details included.
*/
private function get_details() {
$details = wp_cache_get( $this->blog_id, 'site-details' );
if ( false === $details ) {
switch_to_blog( $this->blog_id );
// Create a raw copy of the object for backwards compatibility with the filter below.
$details = new stdClass();
foreach ( get_object_vars( $this ) as $key => $value ) {
$details->$key = $value;
}
$details->blogname = get_option( 'blogname' );
$details->siteurl = get_option( 'siteurl' );
$details->post_count = get_option( 'post_count' );
$details->home = get_option( 'home' );
restore_current_blog();
$cache_details = true;
foreach ( array( 'blogname', 'siteurl', 'post_count', 'home' ) as $field ) {
if ( false === $details->$field ) {
$cache_details = false;
break;
}
}
if ( $cache_details ) {
wp_cache_set( $this->blog_id, $details, 'site-details' );
}
}
/**
* Filters a site's extended properties.
*
* @since 4.6.0
*
* @param object $details The site details.
*/
$details = apply_filters( 'site_details', $details );
return $details;
}
}