forked from WordPress/wordpress-develop
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpluggable.php
More file actions
342 lines (302 loc) · 8.93 KB
/
pluggable.php
File metadata and controls
342 lines (302 loc) · 8.93 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
<?php
/**
* @group pluggable
*/
class Tests_Pluggable extends WP_UnitTestCase {
/**
* Tests that the signatures of all functions in pluggable.php match their expected signature.
*
* @ticket 33654
* @ticket 33867
*
* @dataProvider get_defined_pluggable_functions
*/
public function test_pluggable_function_signatures_match( $function ) {
$signatures = $this->get_pluggable_function_signatures();
$this->assertTrue( function_exists( $function ) );
$this->assertArrayHasKey( $function, $signatures );
$function_ref = new ReflectionFunction( $function );
$param_refs = $function_ref->getParameters();
$this->assertSame( count( $signatures[ $function ] ), count( $param_refs ) );
$i = 0;
foreach ( $signatures[ $function ] as $name => $value ) {
$param_ref = $param_refs[ $i ];
$msg = 'Parameter: ' . $param_ref->getName();
if ( is_numeric( $name ) ) {
$name = $value;
$this->assertFalse( $param_ref->isOptional(), $msg );
} else {
$this->assertTrue( $param_ref->isOptional(), $msg );
$this->assertSame( $value, $param_ref->getDefaultValue(), $msg );
}
$this->assertSame( $name, $param_ref->getName(), $msg );
$i++;
}
}
/**
* Test the tests. Makes sure all the expected pluggable functions exist and that they live in pluggable.php.
*
* @ticket 33654
* @ticket 33867
*/
public function test_all_pluggable_functions_exist() {
$defined = wp_list_pluck( $this->get_defined_pluggable_functions(), 0 );
$expected = $this->get_pluggable_function_signatures();
foreach ( $expected as $function => $sig ) {
$msg = 'Function: ' . $function . '()';
$this->assertTrue( function_exists( $function ), $msg );
$this->assertContains( $function, $defined, $msg );
}
}
/**
* Data provider for our pluggable function signature tests.
*
* @return array Data provider array of pluggable function names.
*/
public function get_defined_pluggable_functions() {
require_once ABSPATH . '/wp-admin/includes/upgrade.php';
$test_functions = array(
'install_network',
'wp_install',
'wp_install_defaults',
'wp_new_blog_notification',
'wp_upgrade',
'install_global_terms',
);
$test_files = array(
'wp-includes/pluggable.php',
);
// Pluggable function signatures are not tested when an external object cache is in use. See #31491.
if ( ! wp_using_ext_object_cache() ) {
$test_files[] = 'wp-includes/cache.php';
}
$data = array();
foreach ( $test_functions as $function ) {
$data[] = array(
$function,
);
}
foreach ( $test_files as $file ) {
preg_match_all( '#^\t?function (\w+)#m', file_get_contents( ABSPATH . '/' . $file ), $functions );
foreach ( $functions[1] as $function ) {
$data[] = array(
$function,
);
}
}
return $data;
}
/**
* Expected pluggable function signatures.
*
* @return array Array of signatures keyed by their function name.
*/
public function get_pluggable_function_signatures() {
$signatures = array(
// wp-includes/pluggable.php:
'wp_set_current_user' => array(
'id',
'name' => '',
),
'wp_get_current_user' => array(),
'get_userdata' => array( 'user_id' ),
'get_user_by' => array( 'field', 'value' ),
'cache_users' => array( 'user_ids' ),
'wp_mail' => array(
'to',
'subject',
'message',
'headers' => '',
'attachments' => array(),
),
'wp_authenticate' => array( 'username', 'password' ),
'wp_logout' => array(),
'wp_validate_auth_cookie' => array(
'cookie' => '',
'scheme' => '',
),
'wp_generate_auth_cookie' => array(
'user_id',
'expiration',
'scheme' => 'auth',
'token' => '',
),
'wp_parse_auth_cookie' => array(
'cookie' => '',
'scheme' => '',
),
'wp_set_auth_cookie' => array(
'user_id',
'remember' => false,
'secure' => '',
'token' => '',
),
'wp_clear_auth_cookie' => array(),
'is_user_logged_in' => array(),
'auth_redirect' => array(),
'check_admin_referer' => array(
'action' => -1,
'query_arg' => '_wpnonce',
),
'check_ajax_referer' => array(
'action' => -1,
'query_arg' => false,
'die' => true,
),
'wp_redirect' => array(
'location',
'status' => 302,
'x_redirect_by' => 'WordPress',
),
'wp_sanitize_redirect' => array( 'location' ),
'_wp_sanitize_utf8_in_redirect' => array( 'matches' ),
'wp_safe_redirect' => array(
'location',
'status' => 302,
'x_redirect_by' => 'WordPress',
),
'wp_validate_redirect' => array(
'location',
'default' => '',
),
'wp_notify_postauthor' => array(
'comment_id',
'deprecated' => null,
),
'wp_notify_moderator' => array( 'comment_id' ),
'wp_password_change_notification' => array( 'user' ),
'wp_new_user_notification' => array(
'user_id',
'deprecated' => null,
'notify' => '',
),
'wp_nonce_tick' => array(),
'wp_verify_nonce' => array(
'nonce',
'action' => -1,
),
'wp_create_nonce' => array( 'action' => -1 ),
'wp_salt' => array( 'scheme' => 'auth' ),
'wp_hash' => array(
'data',
'scheme' => 'auth',
),
'wp_hash_password' => array( 'password' ),
'wp_check_password' => array(
'password',
'hash',
'user_id' => '',
),
'wp_generate_password' => array(
'length' => 12,
'special_chars' => true,
'extra_special_chars' => false,
),
'wp_rand' => array(
'min' => 0,
'max' => 0,
),
'wp_set_password' => array( 'password', 'user_id' ),
'get_avatar' => array(
'id_or_email',
'size' => 96,
'default' => '',
'alt' => '',
'args' => null,
),
'wp_text_diff' => array(
'left_string',
'right_string',
'args' => null,
),
// wp-admin/includes/schema.php:
'install_network' => array(),
// wp-admin/includes/upgrade.php:
'wp_install' => array(
'blog_title',
'user_name',
'user_email',
'public',
'deprecated' => '',
'user_password' => '',
'language' => '',
),
'wp_install_defaults' => array( 'user_id' ),
'wp_new_blog_notification' => array( 'blog_title', 'blog_url', 'user_id', 'password' ),
'wp_upgrade' => array(),
'install_global_terms' => array(),
);
// Pluggable function signatures are not tested when an external object cache is in use. See #31491.
if ( ! wp_using_ext_object_cache() ) {
$signatures = array_merge(
$signatures,
array(
// wp-includes/cache.php:
'wp_cache_add' => array(
'key',
'data',
'group' => '',
'expire' => 0,
),
'wp_cache_close' => array(),
'wp_cache_decr' => array(
'key',
'offset' => 1,
'group' => '',
),
'wp_cache_delete' => array(
'key',
'group' => '',
),
'wp_cache_flush' => array(),
'wp_cache_get' => array(
'key',
'group' => '',
'force' => false,
'found' => null,
),
'wp_cache_get_multiple' => array(
'keys',
'group' => '',
'force' => false,
),
'wp_cache_incr' => array(
'key',
'offset' => 1,
'group' => '',
),
'wp_cache_init' => array(),
'wp_cache_replace' => array(
'key',
'data',
'group' => '',
'expire' => 0,
),
'wp_cache_set' => array(
'key',
'data',
'group' => '',
'expire' => 0,
),
'wp_cache_switch_to_blog' => array( 'blog_id' ),
'wp_cache_add_global_groups' => array( 'groups' ),
'wp_cache_add_non_persistent_groups' => array( 'groups' ),
'wp_cache_reset' => array(),
)
);
}
return $signatures;
}
/**
* @ticket 28020
*/
public function test_get_user_by_should_return_same_instance_as_wp_get_current_user() {
// Create a test user.
$new_user = self::factory()->user->create( array( 'role' => 'subscriber' ) );
// Set the test user as the current user.
$current_user = wp_set_current_user( $new_user );
// Get the test user using get_user_by().
$from_get_user_by = get_user_by( 'id', $new_user );
$this->assertSame( $current_user, $from_get_user_by );
}
}