mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-04-03 04:04:35 +00:00
WP_User_Query role improvement redux.
It's back, and it's better than ever: an overhaul of role-related arguments in `WP_User_Query`. This updated version of the previously-reverted [34875] includes support for the use of `$blog_id` without specifying a `$role`, for a 99.7% reduced chance of breaking wordpress.org and other large sites. Props boonebgorges, swissspidy. Fixes #22212. git-svn-id: https://develop.svn.wordpress.org/trunk@34959 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Boone Gorges
@@ -896,4 +896,393 @@ class Tests_User_Query extends WP_UnitTestCase {
|
||||
unset( $q->query_vars[ $k ] );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_get_single_role_by_user_query() {
|
||||
$this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create( array(
|
||||
'role' => 'contributor',
|
||||
) );
|
||||
|
||||
$wp_user_search = new WP_User_Query( array( 'role' => 'subscriber' ) );
|
||||
$users = $wp_user_search->get_results();
|
||||
|
||||
$this->assertEquals( 2, count( $users ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_get_multiple_roles_by_user_query() {
|
||||
$this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 3, array(
|
||||
'role' => 'editor',
|
||||
) );
|
||||
|
||||
$this->factory->user->create( array(
|
||||
'role' => 'contributor',
|
||||
) );
|
||||
|
||||
$wp_user_search = new WP_User_Query( array( 'role__in' => array( 'subscriber', 'editor' ) ) );
|
||||
$users = $wp_user_search->get_results();
|
||||
$this->assertEquals( 5, count( $users ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_get_single_role_by_string() {
|
||||
$this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create( array(
|
||||
'role' => 'contributor',
|
||||
) );
|
||||
|
||||
$users = get_users( array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->assertEquals( 2, count( $users ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_get_single_role_by_array() {
|
||||
$this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create( array(
|
||||
'role' => 'contributor',
|
||||
) );
|
||||
|
||||
$users = get_users( array(
|
||||
'role' => array( 'subscriber' ),
|
||||
) );
|
||||
|
||||
$this->assertEquals( 2, count( $users ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_get_multiple_roles_should_only_match_users_who_have_each_role() {
|
||||
$subscribers = $this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 3, array(
|
||||
'role' => 'editor',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 2, array(
|
||||
'role' => 'administrator',
|
||||
) );
|
||||
|
||||
$users = new WP_User_Query( array( 'role' => array( 'subscriber', 'editor' ) ) );
|
||||
$users = $users->get_results();
|
||||
|
||||
$this->assertEmpty( $users );
|
||||
|
||||
foreach ( $subscribers as $subscriber ) {
|
||||
$subscriber = get_user_by( 'ID', $subscriber );
|
||||
$subscriber->add_role( 'editor' );
|
||||
}
|
||||
|
||||
$users = new WP_User_Query( array( 'role' => array( 'subscriber', 'editor' ) ) );
|
||||
$users = $users->get_results();
|
||||
|
||||
$this->assertEquals( 2, count( $users ) );
|
||||
|
||||
foreach ( $users as $user ) {
|
||||
$this->assertInstanceOf( 'WP_User', $user );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_get_multiple_roles_or() {
|
||||
$this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 3, array(
|
||||
'role' => 'editor',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 2, array(
|
||||
'role' => 'administrator',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 1, array(
|
||||
'role' => 'contributor',
|
||||
) );
|
||||
|
||||
$users = new WP_User_Query( array( 'role__in' => array( 'subscriber', 'editor', 'administrator' ) ) );
|
||||
$users = $users->get_results();
|
||||
|
||||
// +1 for the default user created during installation.
|
||||
$this->assertEquals( 8, count( $users ) );
|
||||
foreach ( $users as $user ) {
|
||||
$this->assertInstanceOf( 'WP_User', $user );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_get_multiple_roles_by_comma_separated_list() {
|
||||
$subscribers = $this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 3, array(
|
||||
'role' => 'editor',
|
||||
) );
|
||||
|
||||
$users = get_users( array(
|
||||
'role' => 'subscriber, editor',
|
||||
) );
|
||||
|
||||
$this->assertEmpty( $users );
|
||||
|
||||
foreach ( $subscribers as $subscriber ) {
|
||||
$subscriber = get_user_by( 'ID', $subscriber );
|
||||
$subscriber->add_role( 'editor' );
|
||||
}
|
||||
|
||||
$users = get_users( array(
|
||||
'role' => 'subscriber, editor',
|
||||
) );
|
||||
|
||||
$this->assertEquals( 2, count( $users ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_get_multiple_roles_with_meta() {
|
||||
// Create administrator user + meta
|
||||
$administrator_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
|
||||
update_user_meta( $administrator_id, 'mk1', 1 );
|
||||
update_user_meta( $administrator_id, 'mk2', 1 );
|
||||
|
||||
// Create editor user + meta
|
||||
$editor_id = $this->factory->user->create( array( 'role' => 'editor' ) );
|
||||
update_user_meta( $editor_id, 'mk1', 1 );
|
||||
update_user_meta( $editor_id, 'mk2', 2 );
|
||||
|
||||
// Create subscriber user + meta
|
||||
$subscriber_id = $this->factory->user->create( array( 'role' => 'subscriber' ) );
|
||||
update_user_meta( $subscriber_id, 'mk1', 1 );
|
||||
update_user_meta( $subscriber_id, 'mk2', 1 );
|
||||
|
||||
// Create contributor user + meta
|
||||
$contributor_id = $this->factory->user->create( array( 'role' => 'contributor' ) );
|
||||
update_user_meta( $contributor_id, 'mk1', 1 );
|
||||
update_user_meta( $contributor_id, 'mk2', 2 );
|
||||
|
||||
// Fetch users
|
||||
$users = get_users( array(
|
||||
'role__in' => array( 'administrator', 'editor', 'subscriber' ),
|
||||
'meta_query' => array(
|
||||
'relation' => 'AND',
|
||||
array(
|
||||
'key' => 'mk1',
|
||||
'value' => '1',
|
||||
'compare' => "=",
|
||||
'type' => 'numeric',
|
||||
),
|
||||
array(
|
||||
'key' => 'mk2',
|
||||
'value' => '2',
|
||||
'compare' => "=",
|
||||
'type' => 'numeric',
|
||||
),
|
||||
),
|
||||
) );
|
||||
|
||||
// Check results
|
||||
$this->assertEquals( 1, count( $users ) );
|
||||
$this->assertSame( $editor_id, (int) $users[0]->ID );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_role_exclusion() {
|
||||
$this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 3, array(
|
||||
'role' => 'editor',
|
||||
) );
|
||||
|
||||
$users = get_users( array(
|
||||
'role__not_in' => 'subscriber',
|
||||
) );
|
||||
|
||||
// +1 for the default user created during installation.
|
||||
$this->assertEquals( 4, count( $users ) );
|
||||
|
||||
$users = get_users( array(
|
||||
'role__not_in' => 'editor',
|
||||
) );
|
||||
|
||||
// +1 for the default user created during installation.
|
||||
$this->assertEquals( 3, count( $users ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_role__in_role__not_in_combined() {
|
||||
$subscribers = $this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 3, array(
|
||||
'role' => 'editor',
|
||||
) );
|
||||
|
||||
foreach ( $subscribers as $subscriber ) {
|
||||
$subscriber = get_user_by( 'ID', $subscriber );
|
||||
$subscriber->add_role( 'editor' );
|
||||
}
|
||||
|
||||
$users = get_users( array(
|
||||
'role__in' => 'editor',
|
||||
) );
|
||||
|
||||
$this->assertEquals( 5, count( $users ) );
|
||||
|
||||
$users = get_users( array(
|
||||
'role__in' => 'editor',
|
||||
'role__not_in' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->assertEquals( 3, count( $users ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_role__not_in_role_combined() {
|
||||
$subscribers = $this->factory->user->create_many( 2, array(
|
||||
'role' => 'subscriber',
|
||||
) );
|
||||
|
||||
$this->factory->user->create_many( 3, array(
|
||||
'role' => 'editor',
|
||||
) );
|
||||
|
||||
$subscriber = get_user_by( 'ID', $subscribers[0] );
|
||||
$subscriber->add_role( 'editor' );
|
||||
|
||||
$users = get_users( array(
|
||||
'role' => 'subscriber',
|
||||
'role__not_in' => array( 'editor' ),
|
||||
) );
|
||||
|
||||
$this->assertEquals( 1, count( $users ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_role__not_in_user_without_role() {
|
||||
$user_without_rule = $this->factory->user->get_object_by_id( $this->factory->user->create( array(
|
||||
'role' => 'subscriber',
|
||||
) ) );
|
||||
|
||||
$user_without_rule->remove_role( 'subscriber' );
|
||||
|
||||
$this->factory->user->create_many( 3, array(
|
||||
'role' => 'editor',
|
||||
) );
|
||||
|
||||
$users = get_users( array(
|
||||
'role__not_in' => 'subscriber',
|
||||
) );
|
||||
|
||||
// +1 for the default user created during installation.
|
||||
$this->assertEquals( 5, count( $users ) );
|
||||
|
||||
$users = get_users( array(
|
||||
'role__not_in' => 'editor',
|
||||
) );
|
||||
|
||||
// +1 for the default user created during installation.
|
||||
$this->assertEquals( 2, count( $users ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
*/
|
||||
public function test_blog_id_should_restrict_by_blog_without_requiring_a_named_role() {
|
||||
if ( ! is_multisite() ) {
|
||||
$this->markTestSkipped( __METHOD__ . ' requires multisite.' );
|
||||
}
|
||||
|
||||
$sites = $this->factory->blog->create_many( 2 );
|
||||
$users = $this->factory->user->create_many( 2 );
|
||||
|
||||
add_user_to_blog( $sites[0], $users[0], 'author' );
|
||||
add_user_to_blog( $sites[1], $users[1], 'author' );
|
||||
|
||||
$found = get_users( array(
|
||||
'blog_id' => $sites[1],
|
||||
'fields' => 'ID',
|
||||
) );
|
||||
|
||||
$this->assertEqualSets( array( $users[1] ), $found );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 22212
|
||||
* @ticket 21119
|
||||
*/
|
||||
public function test_calling_prepare_query_a_second_time_should_not_add_another_cap_query_on_multisite() {
|
||||
if ( ! is_multisite() ) {
|
||||
$this->markTestSkipped( __METHOD__ . ' requires Multisite.' );
|
||||
}
|
||||
|
||||
$site_id = get_current_blog_id();
|
||||
$u = $this->factory->user->create();
|
||||
add_user_to_blog( $site_id, $u, 'author' );
|
||||
|
||||
$q = new WP_User_Query( array(
|
||||
'include' => $u,
|
||||
) );
|
||||
|
||||
$r1 = $q->request;
|
||||
|
||||
$q->prepare_query( array(
|
||||
'include' => $u,
|
||||
) );
|
||||
|
||||
$r2 = $q->request;
|
||||
|
||||
$q->prepare_query( array(
|
||||
'include' => $u,
|
||||
) );
|
||||
|
||||
$r3 = $q->request;
|
||||
|
||||
$this->assertSame( $r1, $r2 );
|
||||
$this->assertSame( $r1, $r3 );
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user