Changeset 37918 for trunk/src/wp-includes/class-wp-site.php

Timestamp:

06/29/2016 07:31:49 PM (10 years ago)

Author:

jeremyfelt

Message:

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.

File:

• trunk/src/wp-includes/class-wp-site.php (modified) (5 diffs)

trunk/src/wp-includes/class-wp-site.php

@@ -223 +223 @@
          *
          * Allows current multisite naming conventions when getting properties.
+         * Allows access to extended site properties.
          *
          * @since 4.6.0
@@ -240 +241 @@
                         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;
                 }
 
@@ -249 +259 @@
          *
          * Allows current multisite naming conventions when checking for properties.
+         * Checks for extended site properties.
          *
          * @since 4.6.0
@@ -262 +273 @@
                         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;
                 }
@@ -293 +312 @@
                 }
         }
+
+        /**
+         * 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;
+        }
 }