forked from WordPress/wordpress-develop
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquery.php
More file actions
689 lines (559 loc) · 17.7 KB
/
query.php
File metadata and controls
689 lines (559 loc) · 17.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
<?php
/**
* Test WP_User Query, in wp-includes/user.php
*
* @group user
*/
class Tests_User_Query extends WP_UnitTestCase {
protected $user_id;
function setUp() {
parent::setUp();
}
function test_get_and_set() {
$users = new WP_User_Query();
$this->assertEquals( '', $users->get( 'fields' ) );
$this->assertEquals( '', @$users->query_vars['fields'] );
$users->set( 'fields', 'all' );
$this->assertEquals( 'all', $users->get( 'fields' ) );
$this->assertEquals( 'all', $users->query_vars['fields'] );
$users->set( 'fields', '' );
$this->assertEquals( '', $users->get( 'fields' ) );
$this->assertEquals( '', $users->query_vars['fields'] );
$this->assertNull( $users->get( 'does-not-exist' ) );
}
public function test_include_single() {
$users = $this->factory->user->create_many( 2 );
$q = new WP_User_Query( array(
'fields' => '',
'include' => $users[0],
) );
$ids = $q->get_results();
$this->assertEquals( array( $users[0] ), $ids );
}
public function test_include_comma_separated() {
$users = $this->factory->user->create_many( 3 );
$q = new WP_User_Query( array(
'fields' => '',
'include' => $users[0] . ', ' . $users[2],
) );
$ids = $q->get_results();
$this->assertEqualSets( array( $users[0], $users[2] ), $ids );
}
public function test_include_array() {
$users = $this->factory->user->create_many( 3 );
$q = new WP_User_Query( array(
'fields' => '',
'include' => array( $users[0], $users[2] ),
) );
$ids = $q->get_results();
$this->assertEqualSets( array( $users[0], $users[2] ), $ids );
}
public function test_include_array_bad_values() {
$users = $this->factory->user->create_many( 3 );
$q = new WP_User_Query( array(
'fields' => '',
'include' => array( $users[0], 'foo', $users[2] ),
) );
$ids = $q->get_results();
$this->assertEqualSets( array( $users[0], $users[2] ), $ids );
}
public function test_exclude() {
$users = $this->factory->user->create_many( 3, array(
'role' => 'author',
) );
$q = new WP_User_Query( array(
'fields' => '',
'exclude' => $users[1],
) );
$ids = $q->get_results();
// Indirect test in order to ignore default user created during installation.
$this->assertNotEmpty( $ids );
$this->assertNotContains( $users[1], $ids );
}
public function test_get_all() {
$this->factory->user->create_many( 3, array(
'role' => 'author'
) );
$users = new WP_User_Query( array( 'blog_id' => get_current_blog_id() ) );
$users = $users->get_results();
// +1 for the default user created during installation.
$this->assertEquals( 4, count( $users ) );
foreach ( $users as $user ) {
$this->assertInstanceOf( 'WP_User', $user );
}
$users = new WP_User_Query( array( 'blog_id' => get_current_blog_id(), 'fields' => 'all_with_meta' ) );
$users = $users->get_results();
$this->assertEquals( 4, count( $users ) );
foreach ( $users as $user ) {
$this->assertInstanceOf( 'WP_User', $user );
}
}
/**
* @dataProvider orderby_should_convert_non_prefixed_keys_data
*/
public function test_orderby_should_convert_non_prefixed_keys( $short_key, $full_key ) {
$q = new WP_User_Query( array(
'orderby' => $short_key,
) );
$this->assertContains( "ORDER BY $full_key", $q->query_orderby );
}
public function orderby_should_convert_non_prefixed_keys_data() {
return array(
array( 'nicename', 'user_nicename' ),
array( 'email', 'user_email' ),
array( 'url', 'user_url' ),
array( 'registered', 'user_registered' ),
array( 'name', 'display_name' ),
);
}
public function test_orderby_meta_value() {
$users = $this->factory->user->create_many( 3, array(
'role' => 'author'
) );
update_user_meta( $users[0], 'last_name', 'Jones' );
update_user_meta( $users[1], 'last_name', 'Albert' );
update_user_meta( $users[2], 'last_name', 'Zorro' );
$q = new WP_User_Query( array(
'include' => $users,
'meta_key' => 'last_name',
'orderby' => 'meta_value',
'fields' => 'ids'
) );
$expected = array( $users[1], $users[0], $users[2] );
$this->assertEquals( $expected, $q->get_results() );
}
/**
* @ticket 27887
*/
public function test_orderby_meta_value_num() {
$users = $this->factory->user->create_many( 3, array(
'role' => 'author'
) );
update_user_meta( $users[0], 'user_age', '101' );
update_user_meta( $users[1], 'user_age', '20' );
update_user_meta( $users[2], 'user_age', '25' );
$q = new WP_User_Query( array(
'include' => $users,
'meta_key' => 'user_age',
'orderby' => 'meta_value_num',
'fields' => 'ids'
) );
$expected = array( $users[1], $users[2], $users[0] );
$this->assertEquals( $expected, $q->get_results() );
}
/**
* @ticket 31265
*/
public function test_orderby_somekey_where_meta_key_is_somekey() {
$users = $this->factory->user->create_many( 3, array(
'role' => 'author'
) );
update_user_meta( $users[0], 'foo', 'zzz' );
update_user_meta( $users[1], 'foo', 'aaa' );
update_user_meta( $users[2], 'foo', 'jjj' );
$q = new WP_User_Query( array(
'include' => $users,
'meta_key' => 'foo',
'orderby' => 'foo',
'fields' => 'ids'
) );
$expected = array( $users[1], $users[2], $users[0] );
$this->assertEquals( $expected, $q->get_results() );
}
/**
* @ticket 31265
*/
public function test_orderby_clause_key() {
$users = $this->factory->user->create_many( 3 );
add_user_meta( $users[0], 'foo', 'aaa' );
add_user_meta( $users[1], 'foo', 'zzz' );
add_user_meta( $users[2], 'foo', 'jjj' );
$q = new WP_User_Query( array(
'fields' => 'ids',
'meta_query' => array(
'foo_key' => array(
'key' => 'foo',
'compare' => 'EXISTS',
),
),
'orderby' => 'foo_key',
'order' => 'DESC',
) );
$this->assertEquals( array( $users[1], $users[2], $users[0] ), $q->results );
}
/**
* @ticket 31265
*/
public function test_orderby_clause_key_as_secondary_sort() {
$u1 = $this->factory->user->create( array(
'user_registered' => '2015-01-28 03:00:00',
) );
$u2 = $this->factory->user->create( array(
'user_registered' => '2015-01-28 05:00:00',
) );
$u3 = $this->factory->user->create( array(
'user_registered' => '2015-01-28 03:00:00',
) );
add_user_meta( $u1, 'foo', 'jjj' );
add_user_meta( $u2, 'foo', 'zzz' );
add_user_meta( $u3, 'foo', 'aaa' );
$q = new WP_User_Query( array(
'fields' => 'ids',
'meta_query' => array(
'foo_key' => array(
'key' => 'foo',
'compare' => 'EXISTS',
),
),
'orderby' => array(
'comment_date' => 'asc',
'foo_key' => 'asc',
),
) );
$this->assertEquals( array( $u3, $u1, $u2 ), $q->results );
}
/**
* @ticket 31265
*/
public function test_orderby_more_than_one_clause_key() {
$users = $this->factory->user->create_many( 3 );
add_user_meta( $users[0], 'foo', 'jjj' );
add_user_meta( $users[1], 'foo', 'zzz' );
add_user_meta( $users[2], 'foo', 'jjj' );
add_user_meta( $users[0], 'bar', 'aaa' );
add_user_meta( $users[1], 'bar', 'ccc' );
add_user_meta( $users[2], 'bar', 'bbb' );
$q = new WP_User_Query( array(
'fields' => 'ids',
'meta_query' => array(
'foo_key' => array(
'key' => 'foo',
'compare' => 'EXISTS',
),
'bar_key' => array(
'key' => 'bar',
'compare' => 'EXISTS',
),
),
'orderby' => array(
'foo_key' => 'asc',
'bar_key' => 'desc',
),
) );
$this->assertEquals( array( $users[2], $users[0], $users[1] ), $q->results );
}
/**
* @ticket 30064
*/
public function test_orderby_include_with_empty_include() {
$q = new WP_User_Query( array(
'orderby' => 'include',
) );
$this->assertContains( 'ORDER BY user_login', $q->query_orderby );
}
/**
* @ticket 30064
*/
public function test_orderby_include() {
global $wpdb;
$users = $this->factory->user->create_many( 4 );
$q = new WP_User_Query( array(
'orderby' => 'include',
'include' => array( $users[1], $users[0], $users[3] ),
'fields' => '',
) );
$expected_orderby = 'ORDER BY FIELD( ' . $wpdb->users . '.ID, ' . $users[1] . ',' . $users[0] . ',' . $users[3] . ' )';
$this->assertContains( $expected_orderby, $q->query_orderby );
// assertEquals() respects order but ignores type (get_results() returns numeric strings).
$this->assertEquals( array( $users[1], $users[0], $users[3] ), $q->get_results() );
}
/**
* @ticket 30064
*/
public function test_orderby_include_duplicate_values() {
global $wpdb;
$users = $this->factory->user->create_many( 4 );
$q = new WP_User_Query( array(
'orderby' => 'include',
'include' => array( $users[1], $users[0], $users[1], $users[3] ),
'fields' => '',
) );
$expected_orderby = 'ORDER BY FIELD( ' . $wpdb->users . '.ID, ' . $users[1] . ',' . $users[0] . ',' . $users[3] . ' )';
$this->assertContains( $expected_orderby, $q->query_orderby );
// assertEquals() respects order but ignores type (get_results() returns numeric strings).
$this->assertEquals( array( $users[1], $users[0], $users[3] ), $q->get_results() );
}
/**
* @ticket 31265
*/
public function test_orderby_space_separated() {
global $wpdb;
$q = new WP_User_Query( array(
'orderby' => 'login nicename',
'order' => 'ASC',
) );
$this->assertContains( "ORDER BY user_login ASC, user_nicename ASC", $q->query_orderby );
}
/**
* @ticket 31265
*/
public function test_orderby_flat_array() {
global $wpdb;
$q = new WP_User_Query( array(
'orderby' => array( 'login', 'nicename' ),
) );
$this->assertContains( "ORDER BY user_login ASC, user_nicename ASC", $q->query_orderby );
}
/**
* @ticket 31265
*/
public function test_orderby_array_contains_invalid_item() {
global $wpdb;
$q = new WP_User_Query( array(
'orderby' => array( 'login', 'foo', 'nicename' ),
) );
$this->assertContains( "ORDER BY user_login ASC, user_nicename ASC", $q->query_orderby );
}
/**
* @ticket 31265
*/
public function test_orderby_array_contains_all_invalid_items() {
global $wpdb;
$q = new WP_User_Query( array(
'orderby' => array( 'foo', 'bar', 'baz' ),
) );
$this->assertContains( "ORDER BY user_login", $q->query_orderby );
}
/**
* @ticket 31265
*/
public function test_orderby_array() {
global $wpdb;
$q = new WP_User_Query( array(
'orderby' => array(
'login' => 'DESC',
'nicename' => 'ASC',
'email' => 'DESC',
),
) );
$this->assertContains( "ORDER BY user_login DESC, user_nicename ASC, user_email DESC", $q->query_orderby );
}
/**
* @ticket 31265
*/
public function test_orderby_array_should_discard_invalid_columns() {
global $wpdb;
$q = new WP_User_Query( array(
'orderby' => array(
'login' => 'DESC',
'foo' => 'ASC',
'email' => 'ASC',
),
) );
$this->assertContains( "ORDER BY user_login DESC, user_email ASC", $q->query_orderby );
}
/**
* @ticket 21119
*/
function test_prepare_query() {
$query = new WP_User_Query();
$this->assertEmpty( $query->query_fields );
$this->assertEmpty( $query->query_from );
$this->assertEmpty( $query->query_limit );
$this->assertEmpty( $query->query_orderby );
$this->assertEmpty( $query->query_where );
$this->assertEmpty( $query->query_vars );
$_query_vars = $query->query_vars;
$query->prepare_query();
$this->assertNotEmpty( $query->query_fields );
$this->assertNotEmpty( $query->query_from );
$this->assertEmpty( $query->query_limit );
$this->assertNotEmpty( $query->query_orderby );
$this->assertNotEmpty( $query->query_where );
$this->assertNotEmpty( $query->query_vars );
$this->assertNotEquals( $_query_vars, $query->query_vars );
// All values get reset
$query->prepare_query( array( 'number' => 8 ) );
$this->assertNotEmpty( $query->query_limit );
$this->assertEquals( 'LIMIT 8', $query->query_limit );
// All values get reset
$query->prepare_query( array( 'fields' => 'all' ) );
$this->assertEmpty( $query->query_limit );
$this->assertEquals( '', $query->query_limit );
$_query_vars = $query->query_vars;
$query->prepare_query();
$this->assertEquals( $_query_vars, $query->query_vars );
}
public function test_meta_vars_should_be_converted_to_meta_query() {
$q = new WP_User_Query( array(
'meta_key' => 'foo',
'meta_value' => '5',
'meta_compare' => '>',
'meta_type' => 'SIGNED',
) );
// Multisite adds a 'blog_id' clause, so we have to find the 'foo' clause.
$mq_clauses = $q->meta_query->get_clauses();
foreach ( $mq_clauses as $mq_clause ) {
if ( 'foo' === $mq_clause['key'] ) {
$clause = $mq_clause;
}
}
$this->assertSame( 'foo', $clause['key'] );
$this->assertSame( '5', $clause['value'] );
$this->assertSame( '>', $clause['compare'] );
$this->assertSame( 'SIGNED', $clause['type'] );
}
/**
* @ticket 23849
*/
function test_meta_query_with_role() {
$author_ids = $this->factory->user->create_many( 4, array( 'role' => 'author' ) );
add_user_meta( $author_ids[0], 'foo', 'bar' );
add_user_meta( $author_ids[1], 'foo', 'baz' );
// Users with foo = bar or baz restricted to the author role.
$query = new WP_User_Query( array(
'fields' => '',
'role' => 'author',
'meta_query' => array(
'relation' => 'OR',
array(
'key' => 'foo',
'value' => 'bar',
),
array(
'key' => 'foo',
'value' => 'baz',
),
),
) );
$this->assertEquals( array( $author_ids[0], $author_ids[1] ), $query->get_results() );
}
public function test_roles_and_caps_should_be_populated_for_default_value_of_blog_id() {
$u = $this->factory->user->create( array( 'role' => 'author' ) );
$query = new WP_User_Query( array(
'include' => $u,
) );
$found = $query->get_results();
$this->assertNotEmpty( $found );
$user = reset( $found );
$this->assertSame( array( 'author' ), $user->roles );
$this->assertSame( array( 'author' => true ), $user->caps );
}
public function test_roles_and_caps_should_be_populated_for_explicit_value_of_blog_id_on_nonms() {
if ( is_multisite() ) {
$this->markTestSkipped( __METHOD__ . ' is a non-multisite-only test.' );
}
$u = $this->factory->user->create( array( 'role' => 'author' ) );
$query = new WP_User_Query( array(
'include' => $u,
'blog_id' => get_current_blog_id(),
) );
$found = $query->get_results();
$this->assertNotEmpty( $found );
$user = reset( $found );
$this->assertSame( array( 'author' ), $user->roles );
$this->assertSame( array( 'author' => true ), $user->caps );
}
public function test_roles_and_caps_should_be_populated_for_explicit_value_of_current_blog_id_on_ms() {
if ( ! is_multisite() ) {
$this->markTestSkipped( __METHOD__ . ' is a multisite-only test.' );
}
$u = $this->factory->user->create( array( 'role' => 'author' ) );
$query = new WP_User_Query( array(
'include' => $u,
'blog_id' => get_current_blog_id(),
) );
$found = $query->get_results();
$this->assertNotEmpty( $found );
$user = reset( $found );
$this->assertSame( array( 'author' ), $user->roles );
$this->assertSame( array( 'author' => true ), $user->caps );
}
public function test_roles_and_caps_should_be_populated_for_explicit_value_of_different_blog_id_on_ms_when_fields_all_with_meta() {
if ( ! is_multisite() ) {
$this->markTestSkipped( __METHOD__ . ' is a multisite-only test.' );
}
$b = $this->factory->blog->create();
$u = $this->factory->user->create();
add_user_to_blog( $b, $u, 'author' );
$query = new WP_User_Query( array(
'include' => $u,
'blog_id' => $b,
'fields' => 'all_with_meta',
) );
$found = $query->get_results();
$this->assertNotEmpty( $found );
$user = reset( $found );
$this->assertSame( array( 'author' ), $user->roles );
$this->assertSame( array( 'author' => true ), $user->caps );
}
/**
* @ticket 31878
*/
public function test_roles_and_caps_should_be_populated_for_explicit_value_of_different_blog_id_on_ms_when_fields_all() {
if ( ! is_multisite() ) {
$this->markTestSkipped( __METHOD__ . ' is a multisite-only test.' );
}
$b = $this->factory->blog->create();
$u = $this->factory->user->create();
add_user_to_blog( $b, $u, 'author' );
$query = new WP_User_Query( array(
'fields' => 'all',
'include' => $u,
'blog_id' => $b,
) );
$found = $query->get_results();
$this->assertNotEmpty( $found );
$user = reset( $found );
$this->assertSame( array( 'author' ), $user->roles );
$this->assertSame( array( 'author' => true ), $user->caps );
}
/**
* @ticket 32019
*/
public function test_who_authors() {
if ( ! is_multisite() ) {
$this->markTestSkipped( __METHOD__ . ' requires multisite.' );
}
$b = $this->factory->blog->create();
$users = $this->factory->user->create_many( 3 );
add_user_to_blog( $b, $users[0], 'subscriber' );
add_user_to_blog( $b, $users[1], 'author' );
add_user_to_blog( $b, $users[2], 'editor' );
$q = new WP_User_Query( array(
'who' => 'authors',
'blog_id' => $b,
) );
$found = wp_list_pluck( $q->get_results(), 'ID' );
$this->assertNotContains( $users[0], $found );
$this->assertContains( $users[1], $found );
$this->assertContains( $users[2], $found );
}
/**
* @ticket 32019
*/
public function test_who_authors_should_work_alongside_meta_query() {
if ( ! is_multisite() ) {
$this->markTestSkipped( __METHOD__ . ' requires multisite.' );
}
$b = $this->factory->blog->create();
$users = $this->factory->user->create_many( 3 );
add_user_to_blog( $b, $users[0], 'subscriber' );
add_user_to_blog( $b, $users[1], 'author' );
add_user_to_blog( $b, $users[2], 'editor' );
add_user_meta( $users[1], 'foo', 'bar' );
add_user_meta( $users[2], 'foo', 'baz' );
$q = new WP_User_Query( array(
'who' => 'authors',
'blog_id' => $b,
'meta_query' => array(
'key' => 'foo',
'value' => 'bar',
),
) );
$found = wp_list_pluck( $q->get_results(), 'ID' );
$this->assertNotContains( $users[0], $found );
$this->assertContains( $users[1], $found );
$this->assertNotContains( $users[2], $found );
}
}