Changeset 37326

Timestamp:

04/29/2016 03:52:34 PM (8 years ago)

Author:

jeremyfelt

Message:

Multisite: Add the pre_get_blogs_of_user filter

This allows a plugin to short circuit get_blogs_of_user() in cases where the default behavior of the function is unnecessary or slow. (e.g. A user is a member of thousands of sites.)

Props jsternberg.
See #31746, Fixes #36707.

File:

• trunk/src/wp-includes/user.php (modified) (1 diff)

trunk/src/wp-includes/user.php

@@ -578 +578 @@
     if ( empty( $user_id ) )
         return array();
+
+    /**
+     * Filter the list of a user's sites before it is populated.
+     *
+     * Passing a non-null value to the filter will effectively short circuit
+     * get_blogs_of_user(), returning that value instead.
+     *
+     * @since 4.6.0
+     *
+     * @param null|array $blogs   An array of WP_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;
+    }
 
     $keys = get_user_meta( $user_id );