Changeset 53362 for trunk/src/wp-includes/class-wp-user-query.php

Timestamp:

05/07/2022 03:30:51 AM (4 years ago)

Author:

peterwilsoncc

Message:

Users: Allow any DB field to be returned by WP_User_Query.

Restore behaviour of fields parameter in WP_User_Query to allow developers to specify any database field to be returned either individually or as part of a subset. Add these fields to the documentation.

When a subset of fields includes the id paramater, include it in the results in both upper and lowercase to maintain backward compatibility.

Follow up to [53327].

Props dd32, pbearne, kraftbj, peterwilsoncc.
Fixes #53177.

File:

• trunk/src/wp-includes/class-wp-user-query.php (modified) (4 diffs)

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

@@ -231 +231 @@
          *                                                - 'user_url'
          *                                                - 'user_registered'
+         *                                                - 'user_pass'
+         *                                                - 'user_activation_key'
+         *                                                - 'user_status'
+         *                                                - 'spam' (only available on multisite installs)
+         *                                                - 'deleted' (only available on multisite installs)
          *                                                - 'all' for all fields
          *                                                - 'all_with_meta' to include meta fields.
@@ -276 +281 @@
 
                 $allowed_fields = array(
-                        'ID',
-                        'display_name',
+                        'id',
                         'user_login',
+                        'user_pass',
                         'user_nicename',
                         'user_email',
                         'user_url',
                         'user_registered',
+                        'user_activation_key',
+                        'user_status',
+                        'display_name',
                 );
+                if ( is_multisite() ) {
+                        $allowed_fields[] = 'spam';
+                        $allowed_fields[] = 'deleted';
+                }
 
                 if ( is_array( $qv['fields'] ) ) {
+                        $qv['fields'] = array_map( 'strtolower', $qv['fields'] );
                         $qv['fields'] = array_intersect( array_unique( $qv['fields'] ), $allowed_fields );
 
                         if ( empty( $qv['fields'] ) ) {
-                                $qv['fields'] = array( 'ID' );
+                                $qv['fields'] = array( 'id' );
                         }
 
                         $this->query_fields = array();
                         foreach ( $qv['fields'] as $field ) {
-                                $field                = 'ID' === $field ? 'ID' : sanitize_key( $field );
+                                $field                = 'id' === $field ? 'ID' : sanitize_key( $field );
                                 $this->query_fields[] = "$wpdb->users.$field";
                         }
@@ -303 +316 @@
                         $this->query_fields = "$wpdb->users.ID";
                 } else {
-                        $field              = 'ID' === $qv['fields'] ? 'ID' : sanitize_key( $qv['fields'] );
+                        $field              = 'id' === strtolower( $qv['fields'] ) ? 'ID' : sanitize_key( $qv['fields'] );
                         $this->query_fields = "$wpdb->users.$field";
                 }
@@ -823 +836 @@
                         return;
                 }
-
-                if ( 'all_with_meta' === $qv['fields'] ) {
+                if (
+                        is_array( $qv['fields'] ) &&
+                        isset( $this->results[0]->ID )
+                ) {
+                        foreach ( $this->results as $result ) {
+                                $result->id = $result->ID;
+                        }
+                } elseif ( 'all_with_meta' === $qv['fields'] ) {
                         cache_users( $this->results );