forked from WordPress/wordpress-develop
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfilters.php
More file actions
383 lines (307 loc) · 11 KB
/
filters.php
File metadata and controls
383 lines (307 loc) · 11 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
<?php
/**
* Test apply_filters() and related functions
*
* @group hooks
*/
class Tests_Filters extends WP_UnitTestCase {
function test_simple_filter() {
$a = new MockAction();
$tag = __FUNCTION__;
$val = __FUNCTION__ . '_val';
add_filter( $tag, array( $a, 'filter' ) );
$this->assertSame( $val, apply_filters( $tag, $val ) );
// Only one event occurred for the hook, with empty args.
$this->assertSame( 1, $a->get_call_count() );
// Only our hook was called.
$this->assertSame( array( $tag ), $a->get_tags() );
$argsvar = $a->get_args();
$args = array_pop( $argsvar );
$this->assertSame( array( $val ), $args );
}
function test_remove_filter() {
$a = new MockAction();
$tag = __FUNCTION__;
$val = __FUNCTION__ . '_val';
add_filter( $tag, array( $a, 'filter' ) );
$this->assertSame( $val, apply_filters( $tag, $val ) );
// Make sure our hook was called correctly.
$this->assertSame( 1, $a->get_call_count() );
$this->assertSame( array( $tag ), $a->get_tags() );
// Now remove the filter, do it again, and make sure it's not called this time.
remove_filter( $tag, array( $a, 'filter' ) );
$this->assertSame( $val, apply_filters( $tag, $val ) );
$this->assertSame( 1, $a->get_call_count() );
$this->assertSame( array( $tag ), $a->get_tags() );
}
function test_has_filter() {
$tag = __FUNCTION__;
$func = __FUNCTION__ . '_func';
$this->assertFalse( has_filter( $tag, $func ) );
$this->assertFalse( has_filter( $tag ) );
add_filter( $tag, $func );
$this->assertSame( 10, has_filter( $tag, $func ) );
$this->assertTrue( has_filter( $tag ) );
remove_filter( $tag, $func );
$this->assertFalse( has_filter( $tag, $func ) );
$this->assertFalse( has_filter( $tag ) );
}
// One tag with multiple filters.
function test_multiple_filters() {
$a1 = new MockAction();
$a2 = new MockAction();
$tag = __FUNCTION__;
$val = __FUNCTION__ . '_val';
// Add both filters to the hook.
add_filter( $tag, array( $a1, 'filter' ) );
add_filter( $tag, array( $a2, 'filter' ) );
$this->assertSame( $val, apply_filters( $tag, $val ) );
// Both filters called once each.
$this->assertSame( 1, $a1->get_call_count() );
$this->assertSame( 1, $a2->get_call_count() );
}
function test_filter_args_1() {
$a = new MockAction();
$tag = __FUNCTION__;
$val = __FUNCTION__ . '_val';
$arg1 = __FUNCTION__ . '_arg1';
add_filter( $tag, array( $a, 'filter' ), 10, 2 );
// Call the filter with a single argument.
$this->assertSame( $val, apply_filters( $tag, $val, $arg1 ) );
$this->assertSame( 1, $a->get_call_count() );
$argsvar = $a->get_args();
$this->assertSame( array( $val, $arg1 ), array_pop( $argsvar ) );
}
function test_filter_args_2() {
$a1 = new MockAction();
$a2 = new MockAction();
$tag = __FUNCTION__;
$val = __FUNCTION__ . '_val';
$arg1 = __FUNCTION__ . '_arg1';
$arg2 = __FUNCTION__ . '_arg2';
// $a1 accepts two arguments, $a2 doesn't.
add_filter( $tag, array( $a1, 'filter' ), 10, 3 );
add_filter( $tag, array( $a2, 'filter' ) );
// Call the filter with two arguments.
$this->assertSame( $val, apply_filters( $tag, $val, $arg1, $arg2 ) );
// $a1 should be called with both args.
$this->assertSame( 1, $a1->get_call_count() );
$argsvar1 = $a1->get_args();
$this->assertSame( array( $val, $arg1, $arg2 ), array_pop( $argsvar1 ) );
// $a2 should be called with one only.
$this->assertSame( 1, $a2->get_call_count() );
$argsvar2 = $a2->get_args();
$this->assertSame( array( $val ), array_pop( $argsvar2 ) );
}
function test_filter_priority() {
$a = new MockAction();
$tag = __FUNCTION__;
$val = __FUNCTION__ . '_val';
// Make two filters with different priorities.
add_filter( $tag, array( $a, 'filter' ), 10 );
add_filter( $tag, array( $a, 'filter2' ), 9 );
$this->assertSame( $val, apply_filters( $tag, $val ) );
// There should be two events, one per filter.
$this->assertSame( 2, $a->get_call_count() );
$expected = array(
// 'filter2' is called first because it has priority 9.
array(
'filter' => 'filter2',
'tag' => $tag,
'args' => array( $val ),
),
// 'filter' is called second.
array(
'filter' => 'filter',
'tag' => $tag,
'args' => array( $val ),
),
);
$this->assertSame( $expected, $a->get_events() );
}
function test_all_filter() {
$a = new MockAction();
$tag1 = __FUNCTION__ . '_1';
$tag2 = __FUNCTION__ . '_2';
$val = __FUNCTION__ . '_val';
// Add an 'all' filter.
add_filter( 'all', array( $a, 'filterall' ) );
// Apply some filters.
$this->assertSame( $val, apply_filters( $tag1, $val ) );
$this->assertSame( $val, apply_filters( $tag2, $val ) );
$this->assertSame( $val, apply_filters( $tag1, $val ) );
$this->assertSame( $val, apply_filters( $tag1, $val ) );
// Our filter should have been called once for each apply_filters call.
$this->assertSame( 4, $a->get_call_count() );
// The right hooks should have been called in order.
$this->assertSame( array( $tag1, $tag2, $tag1, $tag1 ), $a->get_tags() );
remove_filter( 'all', array( $a, 'filterall' ) );
$this->assertFalse( has_filter( 'all', array( $a, 'filterall' ) ) );
}
function test_remove_all_filter() {
$a = new MockAction();
$tag = __FUNCTION__;
$val = __FUNCTION__ . '_val';
add_filter( 'all', array( $a, 'filterall' ) );
$this->assertTrue( has_filter( 'all' ) );
$this->assertSame( 10, has_filter( 'all', array( $a, 'filterall' ) ) );
$this->assertSame( $val, apply_filters( $tag, $val ) );
// Make sure our hook was called correctly.
$this->assertSame( 1, $a->get_call_count() );
$this->assertSame( array( $tag ), $a->get_tags() );
// Now remove the filter, do it again, and make sure it's not called this time.
remove_filter( 'all', array( $a, 'filterall' ) );
$this->assertFalse( has_filter( 'all', array( $a, 'filterall' ) ) );
$this->assertFalse( has_filter( 'all' ) );
$this->assertSame( $val, apply_filters( $tag, $val ) );
// Call cound should remain at 1.
$this->assertSame( 1, $a->get_call_count() );
$this->assertSame( array( $tag ), $a->get_tags() );
}
/**
* @ticket 20920
*/
function test_remove_all_filters_should_respect_the_priority_argument() {
$a = new MockAction();
$tag = __FUNCTION__;
$val = __FUNCTION__ . '_val';
add_filter( $tag, array( $a, 'filter' ), 12 );
$this->assertTrue( has_filter( $tag ) );
// Should not be removed.
remove_all_filters( $tag, 11 );
$this->assertTrue( has_filter( $tag ) );
remove_all_filters( $tag, 12 );
$this->assertFalse( has_filter( $tag ) );
}
/**
* @ticket 9886
*/
function test_filter_ref_array() {
$obj = new stdClass();
$a = new MockAction();
$tag = __FUNCTION__;
add_action( $tag, array( $a, 'filter' ) );
apply_filters_ref_array( $tag, array( &$obj ) );
$args = $a->get_args();
$this->assertSame( $args[0][0], $obj );
// Just in case we don't trust assertSame().
$obj->foo = true;
$this->assertNotEmpty( $args[0][0]->foo );
}
/**
* @ticket 12723
*/
function test_filter_ref_array_result() {
$obj = new stdClass();
$a = new MockAction();
$b = new MockAction();
$tag = __FUNCTION__;
add_action( $tag, array( $a, 'filter_append' ), 10, 2 );
add_action( $tag, array( $b, 'filter_append' ), 10, 2 );
$result = apply_filters_ref_array( $tag, array( 'string', &$obj ) );
$this->assertSame( $result, 'string_append_append' );
$args = $a->get_args();
$this->assertSame( $args[0][1], $obj );
// Just in case we don't trust assertSame().
$obj->foo = true;
$this->assertNotEmpty( $args[0][1]->foo );
$args = $b->get_args();
$this->assertSame( $args[0][1], $obj );
// Just in case we don't trust assertSame().
$obj->foo = true;
$this->assertNotEmpty( $args[0][1]->foo );
}
function _self_removal( $tag ) {
remove_action( $tag, array( $this, '_self_removal' ), 10, 1 );
return $tag;
}
/**
* @ticket 29070
*/
function test_has_filter_after_remove_all_filters() {
$a = new MockAction();
$tag = __FUNCTION__;
$val = __FUNCTION__ . '_val';
// No priority.
add_filter( $tag, array( $a, 'filter' ), 11 );
add_filter( $tag, array( $a, 'filter' ), 12 );
$this->assertTrue( has_filter( $tag ) );
remove_all_filters( $tag );
$this->assertFalse( has_filter( $tag ) );
// Remove priorities one at a time.
add_filter( $tag, array( $a, 'filter' ), 11 );
add_filter( $tag, array( $a, 'filter' ), 12 );
$this->assertTrue( has_filter( $tag ) );
remove_all_filters( $tag, 11 );
remove_all_filters( $tag, 12 );
$this->assertFalse( has_filter( $tag ) );
}
/**
* @ticket 10441
* @expectedDeprecated tests_apply_filters_deprecated
*/
public function test_apply_filters_deprecated() {
$p = 'Foo';
add_filter( 'tests_apply_filters_deprecated', array( __CLASS__, 'deprecated_filter_callback' ) );
$p = apply_filters_deprecated( 'tests_apply_filters_deprecated', array( $p ), '4.6.0' );
remove_filter( 'tests_apply_filters_deprecated', array( __CLASS__, 'deprecated_filter_callback' ) );
$this->assertSame( 'Bar', $p );
}
public static function deprecated_filter_callback( $p ) {
$p = 'Bar';
return $p;
}
/**
* @ticket 10441
* @expectedDeprecated tests_apply_filters_deprecated
*/
public function test_apply_filters_deprecated_with_multiple_params() {
$p1 = 'Foo1';
$p2 = 'Foo2';
add_filter( 'tests_apply_filters_deprecated', array( __CLASS__, 'deprecated_filter_callback_multiple_params' ), 10, 2 );
$p1 = apply_filters_deprecated( 'tests_apply_filters_deprecated', array( $p1, $p2 ), '4.6.0' );
remove_filter( 'tests_apply_filters_deprecated', array( __CLASS__, 'deprecated_filter_callback_multiple_params' ), 10, 2 );
$this->assertSame( 'Bar1', $p1 );
// Not passed by reference, so not modified.
$this->assertSame( 'Foo2', $p2 );
}
public static function deprecated_filter_callback_multiple_params( $p1, $p2 ) {
$p1 = 'Bar1';
$p2 = 'Bar2';
return $p1;
}
/**
* @ticket 10441
*/
public function test_apply_filters_deprecated_without_filter() {
$val = 'Foobar';
$this->assertSame( $val, apply_filters_deprecated( 'tests_apply_filters_deprecated', array( $val ), '4.6.0' ) );
}
private $current_priority;
/**
* @ticket 39007
*/
public function test_current_priority() {
add_action( 'test_current_priority', array( $this, '_current_priority_action' ), 99 );
do_action( 'test_current_priority' );
remove_action( 'test_current_priority', array( $this, '_current_priority_action' ), 99 );
$this->assertSame( 99, $this->current_priority );
}
public function _current_priority_action() {
global $wp_filter;
$this->current_priority = $wp_filter[ current_filter() ]->current_priority();
}
/**
* @ticket 39007
*/
public function test_other_priority() {
add_action( 'test_current_priority', array( $this, '_other_priority_action' ), 99 );
do_action( 'test_current_priority' );
remove_action( 'test_current_priority', array( $this, '_other_priority_action' ), 99 );
$this->assertFalse( $this->current_priority );
}
public function _other_priority_action() {
global $wp_filter;
$this->current_priority = $wp_filter['the_content']->current_priority();
}
}