mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-04-12 16:15:07 +02:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

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

Browse Source 
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, SergeyBiryukov.
Merges [53362,53373] to the 6.0 branch.
Fixes #53177.


git-svn-id: https://develop.svn.wordpress.org/branches/6.0@53374 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Peter Wilson 2022-05-10 05:51:33 +00:00
parent a6c5dcbbe4
commit 60408de989
2 changed files with 227 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/wp-includes/class-wp-user-query.php
View File

@ -230,6 +230,11 @@ class WP_User_Query {
* - 'user_email'
* - '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.
* Default 'all'.
@ -275,25 +280,33 @@ class WP_User_Query {
$qv = $this->fill_query_vars( $qv );
$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";
}
$this->query_fields = implode( ',', $this->query_fields );
@ -302,7 +315,7 @@ class WP_User_Query {
} elseif ( ! in_array( $qv['fields'], $allowed_fields, true ) ) {
$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";
}
@ -822,8 +835,14 @@ class WP_User_Query {
if ( ! $this->results ) {
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 );
$r = array();

303
tests/phpunit/tests/user/query.php
View File

@ -1969,14 +1969,12 @@ class Tests_User_Query extends WP_UnitTestCase {
/**
* @ticket 53177
* @dataProvider data_returning_fields
* @dataProvider data_returning_field_subset_as_string
*
* @covers WP_User_Query::prepare_query
*
* @param $field
* @param $expected
* @param string $field
* @param mixed $expected
*/
public function test_returning_fields( $field, $expected_values ) {
public function test_returning_field_subset_as_string( $field, $expected ) {
$q = new WP_User_Query(
array(
'fields' => $field,
@ -1985,114 +1983,215 @@ class Tests_User_Query extends WP_UnitTestCase {
);
$results = $q->get_results();
if ( 'all_with_meta' === $field ) {
$data = array_shift( $results )->data;
} else {
$data = ( isset( $results[0]->data ) ) ? $results[0]->data : $results[0];
}
foreach ( $expected_values as $key => $expected_value ) {
if ( ! is_array( $results ) ) {
$this->assertEquals( array_shift( $results ), $expected_value );
} else {
$value = ( isset( $data->$key ) ) ? $data->$key : $data;
$this->assertEquals( $value, $expected_value );
}
}
$this->assertSameSets( $expected, $results );
}
public function data_returning_fields() {
return array(
'all' => array(
'field' => 'all',
'expected' => array(
'ID' => '1',
'user_login' => 'admin',
'user_nicename' => 'admin',
'user_email' => WP_TESTS_EMAIL,
'user_url' => wp_guess_url(),
'user_activation_key' => '',
'user_status' => '0',
'display_name' => 'admin',
),
/**
* Data provider
*
* @return array
*/
function data_returning_field_subset_as_string() {
$data = array(
'id' => array(
'fields' => 'id',
'expected' => array( '1' ),
),
'all_with_meta' => array(
'field' => 'all_with_meta',
'expected' => array(
'ID' => '1',
'user_login' => 'admin',
'user_nicename' => 'admin',
'user_email' => WP_TESTS_EMAIL,
'user_url' => wp_guess_url(),
'user_activation_key' => '',
'user_status' => '0',
'display_name' => 'admin',
),
'ID' => array(
'fields' => 'ID',
'expected' => array( '1' ),
),
'ID' => array(
'field' => 'ID',
'expected' => array(
'ID' => '1',
),
'user_login' => array(
'fields' => 'user_login',
'expected' => array( 'admin' ),
),
'id' => array(
'field' => 'id',
'expected' => array(
'ID' => '1',
),
'user_nicename' => array(
'fields' => 'user_nicename',
'expected' => array( 'admin' ),
),
'display_name' => array(
'field' => 'display_name',
'expected' => array(
'display_name' => 'admin',
),
'user_email' => array(
'fields' => 'user_email',
'expected' => array( WP_TESTS_EMAIL ),
),
'user_login' => array(
'field' => 'user_login',
'expected' => array(
'user_login' => 'admin',
),
'user_url' => array(
'fields' => 'user_url',
'expected' => array( wp_guess_url() ),
),
'user_nicename' => array(
'field' => 'user_nicename',
'expected' => array(
'user_nicename' => 'admin',
),
'user_status' => array(
'fields' => 'user_status',
'expected' => array( '0' ),
),
'user_email' => array(
'field' => 'user_email',
'expected' => array(
'user_email' => WP_TESTS_EMAIL,
),
'display_name' => array(
'fields' => 'display_name',
'expected' => array( 'admin' ),
),
'invalid_field' => array(
'field' => 'invalid_field',
'expected' => array(
'0' => '1',
),
),
'valid_array' => array(
'field' => array( 'ID', 'display_name' ),
'expected' => array(
'ID' => '1',
'display_name' => 'admin',
),
),
'semivalid_array' => array(
'field' => array( 'ID', 'display_name', 'invalid_field' ),
'expected' => array(
'ID' => '1',
'display_name' => 'admin',
),
),
'invalid_array' => array(
'field' => array( 'invalid_field' ),
'expected' => array(
'ID' => '1',
),
'invalid_field' => array(
'fields' => 'invalid_field',
'expected' => array( '1' ),
),
);
if ( is_multisite() ) {
$data['spam'] = array(
'fields' => 'spam',
'expected' => array( '0' ),
);
$data['deleted'] = array(
'fields' => 'deleted',
'expected' => array( '0' ),
);
}
return $data;
}
/**
* @ticket 53177
* @dataProvider data_returning_field_subset_as_array
*
* @param array $field
* @param mixed $expected
*/
public function test_returning_field_subset_as_array( $field, $expected ) {
$q = new WP_User_Query(
array(
'fields' => $field,
'include' => array( '1' ),
)
);
$results = $q->get_results();
if ( isset( $results[0] ) && is_object( $results[0] ) ) {
$results = (array) $results[0];
}
$this->assertSameSetsWithIndex( $expected, $results );
}
/**
* Data provider
*
* @return array
*/
function data_returning_field_subset_as_array() {
$data = array(
'id' => array(
'fields' => array( 'id' ),
'expected' => array(
'ID' => '1',
'id' => '1',
),
),
'ID' => array(
'fields' => array( 'ID' ),
'expected' => array(
'ID' => '1',
'id' => '1',
),
),
'user_login' => array(
'fields' => array( 'user_login' ),
'expected' => array( 'user_login' => 'admin' ),
),
'user_nicename' => array(
'fields' => array( 'user_nicename' ),
'expected' => array( 'user_nicename' => 'admin' ),
),
'user_email' => array(
'fields' => array( 'user_email' ),
'expected' => array( 'user_email' => WP_TESTS_EMAIL ),
),
'user_url' => array(
'fields' => array( 'user_url' ),
'expected' => array( 'user_url' => wp_guess_url() ),
),
'user_status' => array(
'fields' => array( 'user_status' ),
'expected' => array( 'user_status' => '0' ),
),
'display_name' => array(
'fields' => array( 'display_name' ),
'expected' => array( 'display_name' => 'admin' ),
),
'invalid_field' => array(
'fields' => array( 'invalid_field' ),
'expected' => array(
'ID' => '1',
'id' => '1',
),
),
'valid array inc id' => array(
'fields' => array( 'display_name', 'user_email', 'id' ),
'expected' => array(
'display_name' => 'admin',
'user_email' => WP_TESTS_EMAIL,
'ID' => '1',
'id' => '1',
),
),
'valid array inc ID' => array(
'fields' => array( 'display_name', 'user_email', 'ID' ),
'expected' => array(
'display_name' => 'admin',
'user_email' => WP_TESTS_EMAIL,
'ID' => '1',
'id' => '1',
),
),
'partly valid array' => array(
'fields' => array( 'display_name', 'invalid_field' ),
'expected' => array( 'display_name' => 'admin' ),
),
);
if ( is_multisite() ) {
$data['spam'] = array(
'fields' => array( 'spam' ),
'expected' => array( 'spam' => '0' ),
);
$data['deleted'] = array(
'fields' => array( 'deleted' ),
'expected' => array( 'deleted' => '0' ),
);
}
return $data;
}
/**
* @ticket 53177
*/
public function test_returning_field_all() {
$q = new WP_User_Query(
array(
'fields' => 'all',
'include' => array( '1' ),
)
);
$results = $q->get_results();
$user_data = (array) $results[0]->data;
$expected_results = array(
'ID' => '1',
'user_login' => 'admin',
'user_nicename' => 'admin',
'user_url' => wp_guess_url(),
'user_email' => WP_TESTS_EMAIL,
'user_activation_key' => '',
'user_status' => '0',
'display_name' => 'admin',
);
if ( is_multisite() ) {
$expected_results['spam'] = '0';
$expected_results['deleted'] = '0';
}
// These change for each run.
unset( $user_data['user_pass'], $user_data['user_registered'] );
$this->assertSameSetsWithIndex( $expected_results, $user_data );
$this->assertInstanceOf( 'WP_User', $results[0] );
}
/**