Changeset 38682

Timestamp:

09/30/2016 04:34:18 AM (8 years ago)

Author:

jeremyfelt

Message:

Multisite: Use get_sites() in get_blogs_of_user().

Previously, we looped through all of the site IDs found via user meta and ran get_blog_details() for each site. Now, we can pass all of the site IDs at once to get_sites() and receive full WP_Site objects.

To avoid possible issues with return type, sites are still processed into a standard object that also has a userblog_id property attached. Nothing is changed for non-multisite configurations.

Props flixos90.
Fixes #37061.

File:

• trunk/src/wp-includes/user.php (modified) (6 diffs)

trunk/src/wp-includes/user.php

@@ -560 +560 @@
 
 /**
- * Get the blogs a user belongs to.
+ * Get the sites a user belongs to.
  *
  * @since 3.0.0
+ * @since 4.7.0 Converted to use get_sites().
  *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int  $user_id User ID
- * @param bool $all     Whether to retrieve all blogs, or only blogs that are not
+ * @param bool $all     Whether to retrieve all sites, or only sites that are not
  *                      marked as deleted, archived, or spam.
- * @return array A list of the user's blogs. An empty array if the user doesn't exist
- *               or belongs to no blogs.
+ * @return array A list of the user's sites. An empty array if the user doesn't exist
+ *               or belongs to no sites.
  */
 function get_blogs_of_user( $user_id, $all = false ) {
@@ -577 +578 @@
     $user_id = (int) $user_id;
 
-    // Logged out users can't have blogs
+    // Logged out users can't have sites
     if ( empty( $user_id ) )
         return array();
@@ -589 +590 @@
      * @since 4.6.0
      *
-     * @param null|array $blogs   An array of WP_Site objects of which the user is a member.
+     * @param null|array $sites   An array of site objects of which the user is a member.
      * @param int        $user_id User ID.
      * @param bool       $all     Whether the returned array should contain all sites, including
      *                            those marked 'deleted', 'archived', or 'spam'. Default false.
      */
-    $blogs = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );
-
-    if ( null !== $blogs ) {
-        return $blogs;
+    $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );
+
+    if ( null !== $sites ) {
+        return $sites;
     }
 
@@ -605 +606 @@
 
     if ( ! is_multisite() ) {
-        $blog_id = get_current_blog_id();
-        $blogs = array( $blog_id => new stdClass );
-        $blogs[ $blog_id ]->userblog_id = $blog_id;
-        $blogs[ $blog_id ]->blogname = get_option('blogname');
-        $blogs[ $blog_id ]->domain = '';
-        $blogs[ $blog_id ]->path = '';
-        $blogs[ $blog_id ]->site_id = 1;
-        $blogs[ $blog_id ]->siteurl = get_option('siteurl');
-        $blogs[ $blog_id ]->archived = 0;
-        $blogs[ $blog_id ]->spam = 0;
-        $blogs[ $blog_id ]->deleted = 0;
-        return $blogs;
-    }
-
-    $blogs = array();
+        $site_id = get_current_blog_id();
+        $sites = array( $site_id => new stdClass );
+        $sites[ $site_id ]->userblog_id = $site_id;
+        $sites[ $site_id ]->blogname = get_option('blogname');
+        $sites[ $site_id ]->domain = '';
+        $sites[ $site_id ]->path = '';
+        $sites[ $site_id ]->site_id = 1;
+        $sites[ $site_id ]->siteurl = get_option('siteurl');
+        $sites[ $site_id ]->archived = 0;
+        $sites[ $site_id ]->spam = 0;
+        $sites[ $site_id ]->deleted = 0;
+        return $sites;
+    }
+
+    $site_ids = array();
 
     if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {
-        $blog = get_blog_details( 1 );
-        if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
-            $blogs[ 1 ] = (object) array(
-                'userblog_id' => 1,
-                'blogname'    => $blog->blogname,
-                'domain'      => $blog->domain,
-                'path'        => $blog->path,
-                'site_id'     => $blog->site_id,
-                'siteurl'     => $blog->siteurl,
-                'archived'    => $blog->archived,
-                'mature'      => $blog->mature,
-                'spam'        => $blog->spam,
-                'deleted'     => $blog->deleted,
-            );
-        }
+        $site_ids[] = 1;
         unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
     }
@@ -647 +634 @@
         if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) )
             continue;
-        $blog_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
-        if ( ! is_numeric( $blog_id ) )
+        $site_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
+        if ( ! is_numeric( $site_id ) )
             continue;
 
-        $blog_id = (int) $blog_id;
-        $blog = get_blog_details( $blog_id );
-        if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
-            $blogs[ $blog_id ] = (object) array(
-                'userblog_id' => $blog_id,
-                'blogname'    => $blog->blogname,
-                'domain'      => $blog->domain,
-                'path'        => $blog->path,
-                'site_id'     => $blog->site_id,
-                'siteurl'     => $blog->siteurl,
-                'archived'    => $blog->archived,
-                'mature'      => $blog->mature,
-                'spam'        => $blog->spam,
-                'deleted'     => $blog->deleted,
+        $site_ids[] = (int) $site_id;
+    }
+
+    $sites = array();
+
+    if ( ! empty( $site_ids ) ) {
+        $args = array(
+            'number'   => '',
+            'site__in' => $site_ids,
+        );
+        if ( ! $all ) {
+            $args['archived'] = 0;
+            $args['spam']     = 0;
+            $args['deleted']  = 0;
+        }
+
+        $_sites = get_sites( $args );
+
+        foreach ( $_sites as $site ) {
+            $sites[ $site->id ] = (object) array(
+                'userblog_id' => $site->id,
+                'blogname'    => $site->blogname,
+                'domain'      => $site->domain,
+                'path'        => $site->path,
+                'site_id'     => $site->network_id,
+                'siteurl'     => $site->siteurl,
+                'archived'    => $site->archived,
+                'mature'      => $site->mature,
+                'spam'        => $site->spam,
+                'deleted'     => $site->deleted,
             );
         }
@@ -670 +673 @@
 
     /**
-     * Filters the list of blogs a user belongs to.
+     * Filters the list of sites a user belongs to.
      *
      * @since MU
      *
-     * @param array $blogs   An array of blog objects belonging to the user.
+     * @param array $sites   An array of site objects belonging to the user.
      * @param int   $user_id User ID.
-     * @param bool  $all     Whether the returned blogs array should contain all blogs, including
+     * @param bool  $all     Whether the returned sites array should contain all sites, including
      *                       those marked 'deleted', 'archived', or 'spam'. Default false.
      */
-    return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all );
+    return apply_filters( 'get_blogs_of_user', $sites, $user_id, $all );
 }