Changeset 53655 for trunk

Timestamp:

07/05/2022 09:26:21 AM (4 years ago)

Author:

spacedmonkey

Message:

Users: Prime user meta in WP_User_Query class.

When querying 'fields' equal to 'all' using the WP_User_Query class, this returns an array of WP_User objects. A WP_User object requires user meta to be primed, as the user's role is stored in user meta. Ensure that all users meta is primed in a single request by calling the cache_users function when querying 'fields' equal to 'all'. Soft deprecate fields equal to all_with_meta as it now acts the same as 'fields' equal to 'all'.

Props Spacedmonkey, peterwilsoncc, mehulkaklotar, timothyblynjacobs, furi3r.
Fixes #55594.

Location:

trunk

Files:

• src/wp-includes/class-wp-user-query.php (modified) (4 diffs)
• tests/phpunit/tests/user/query.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-user-query.php

@@ -236 +236 @@
          *                                                - 'spam' (only available on multisite installs)
          *                                                - 'deleted' (only available on multisite installs)
-         *                                                - 'all' for all fields
-         *                                                - 'all_with_meta' to include meta fields.
+         *                                                - 'all' for all fields and loads user meta.
+         *                                                - 'all_with_meta' Deprecated. Use 'all'.
          *                                                Default 'all'.
          *     @type string          $who                 Type of users to query. Accepts 'authors'.
@@ -311 +311 @@
                         }
                         $this->query_fields = implode( ',', $this->query_fields );
-                } elseif ( 'all' === $qv['fields'] ) {
-                        $this->query_fields = "$wpdb->users.*";
-                } elseif ( ! in_array( $qv['fields'], $allowed_fields, true ) ) {
+                } elseif ( 'all_with_meta' === $qv['fields'] || 'all' === $qv['fields'] || ! in_array( $qv['fields'], $allowed_fields, true ) ) {
                         $this->query_fields = "$wpdb->users.ID";
                 } else {
@@ -809 +807 @@
                         ";
 
-                        if ( is_array( $qv['fields'] ) || 'all' === $qv['fields'] ) {
+                        if ( is_array( $qv['fields'] ) ) {
                                 $this->results = $wpdb->get_results( $this->request );
                         } else {
@@ -843 +841 @@
                                 $result->id = $result->ID;
                         }
-                } elseif ( 'all_with_meta' === $qv['fields'] ) {
+                } elseif ( 'all_with_meta' === $qv['fields'] || 'all' === $qv['fields'] ) {
                         cache_users( $this->results );
 
                         $r = array();
                         foreach ( $this->results as $userid ) {
-                                $r[ $userid ] = new WP_User( $userid, '', $qv['blog_id'] );
+                                if ( 'all_with_meta' === $qv['fields'] ) {
+                                        $r[ $userid ] = new WP_User( $userid, '', $qv['blog_id'] );
+                                } else {
+                                        $r[] = new WP_User( $userid, '', $qv['blog_id'] );
+                                }
                         }
 
                         $this->results = $r;
-                } elseif ( 'all' === $qv['fields'] ) {
-                        foreach ( $this->results as $key => $user ) {
-                                $this->results[ $key ] = new WP_User( $user, '', $qv['blog_id'] );
-                        }
                 }
         }

trunk/tests/phpunit/tests/user/query.php

@@ -154 +154 @@
                         $this->assertInstanceOf( 'WP_User', $user );
                 }
+        }
+
+        /**
+         * @ticket 55594
+         */
+        public function test_get_all_primed_users() {
+                $filter = new MockAction();
+                add_filter( 'update_user_metadata_cache', array( $filter, 'filter' ), 10, 2 );
+
+                new WP_User_Query(
+                        array(
+                                'include' => self::$author_ids,
+                                'fields'  => 'all',
+                        )
+                );
+
+                $args      = $filter->get_args();
+                $last_args = end( $args );
+                $this->assertIsArray( $last_args[1] );
+                $this->assertSameSets( self::$author_ids, $last_args[1], 'Ensure that user meta is primed' );
         }