forked from WordPress/wordpress-develop
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsetting.php
More file actions
418 lines (375 loc) · 20.6 KB
/
setting.php
File metadata and controls
418 lines (375 loc) · 20.6 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
<?php
/**
* Tests for the WP_Customize_Setting class.
*
* @group customize
*/
class Tests_WP_Customize_Setting extends WP_UnitTestCase {
/**
* @var WP_Customize_Manager
*/
protected $manager;
/**
* @var stdClass an instance which serves as a symbol to do identity checks with
*/
public $undefined;
function setUp() {
parent::setUp();
require_once( ABSPATH . WPINC . '/class-wp-customize-manager.php' );
$GLOBALS['wp_customize'] = new WP_Customize_Manager();
$this->manager = $GLOBALS['wp_customize'];
$this->undefined = new stdClass();
}
function tearDown() {
$this->manager = null;
unset( $GLOBALS['wp_customize'] );
parent::tearDown();
}
function test_constructor_without_args() {
$setting = new WP_Customize_Setting( $this->manager, 'foo' );
$this->assertEquals( $this->manager, $setting->manager );
$this->assertEquals( 'foo', $setting->id );
$this->assertEquals( 'theme_mod', $setting->type );
$this->assertEquals( 'edit_theme_options', $setting->capability );
$this->assertEquals( '', $setting->theme_supports );
$this->assertEquals( '', $setting->default );
$this->assertEquals( 'refresh', $setting->transport );
$this->assertEquals( '', $setting->sanitize_callback );
$this->assertEquals( '', $setting->sanitize_js_callback );
$this->assertFalse( has_filter( "customize_sanitize_{$setting->id}" ) );
$this->assertFalse( has_filter( "customize_sanitize_js_{$setting->id}" ) );
$this->assertEquals( false, $setting->dirty );
}
function test_constructor_with_args() {
$args = array(
'type' => 'option',
'capability' => 'edit_posts',
'theme_supports' => 'widgets',
'default' => 'barbar',
'transport' => 'postMessage',
'sanitize_callback' => create_function( '$value', 'return $value . ":sanitize_callback";' ),
'sanitize_js_callback' => create_function( '$value', 'return $value . ":sanitize_js_callback";' ),
);
$setting = new WP_Customize_Setting( $this->manager, 'bar', $args );
$this->assertEquals( 'bar', $setting->id );
foreach ( $args as $key => $value ) {
$this->assertEquals( $value, $setting->$key );
}
$this->assertEquals( 10, has_filter( "customize_sanitize_{$setting->id}", $args['sanitize_callback'] ) );
$this->assertEquals( 10, has_filter( "customize_sanitize_js_{$setting->id}" ), $args['sanitize_js_callback'] );
}
public $post_data_overrides = array(
'unset_option_overridden' => 'unset_option_post_override_value',
'unset_theme_mod_overridden' => 'unset_theme_mod_post_override_value',
'set_option_overridden' => 'set_option_post_override_value',
'set_theme_mod_overridden' => 'set_theme_mod_post_override_value',
'unset_option_multi_overridden[foo]' => 'unset_option_multi_overridden[foo]_post_override_value',
'unset_theme_mod_multi_overridden[foo]' => 'unset_theme_mod_multi_overridden[foo]_post_override_value',
'set_option_multi_overridden[foo]' => 'set_option_multi_overridden[foo]_post_override_value',
'set_theme_mod_multi_overridden[foo]' => 'set_theme_mod_multi_overridden[foo]_post_override_value',
);
public $standard_type_configs = array(
'option' => array(
'getter' => 'get_option',
'setter' => 'update_option',
),
'theme_mod' => array(
'getter' => 'get_theme_mod',
'setter' => 'set_theme_mod',
),
);
/**
* Run assertions on non-multidimensional standard settings.
*/
function test_preview_standard_types_non_multidimensional() {
$_POST['customized'] = wp_slash( wp_json_encode( $this->post_data_overrides ) );
// Try non-multidimensional settings
foreach ( $this->standard_type_configs as $type => $type_options ) {
// Non-multidimensional: See what effect the preview filter has on a non-existent setting (default value should be seen)
$name = "unset_{$type}_without_post_value";
$default = "default_value_{$name}";
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
$this->assertEquals( $this->undefined, call_user_func( $type_options['getter'], $name, $this->undefined ) );
$this->assertEquals( $default, $setting->value() );
$setting->preview();
$this->assertEquals( $default, call_user_func( $type_options['getter'], $name, $this->undefined ), sprintf( 'Expected %s(%s) to return setting default: %s.', $type_options['getter'], $name, $default ) );
$this->assertEquals( $default, $setting->value() );
// Non-multidimensional: See what effect the preview has on an extant setting (default value should not be seen)
$name = "set_{$type}_without_post_value";
$default = "default_value_{$name}";
$initial_value = "initial_value_{$name}";
call_user_func( $type_options['setter'], $name, $initial_value );
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
$this->assertEquals( $initial_value, call_user_func( $type_options['getter'], $name ) );
$this->assertEquals( $initial_value, $setting->value() );
$setting->preview();
$this->assertEquals( 0, did_action( "customize_preview_{$setting->id}" ) ); // only applicable for custom types (not options or theme_mods)
$this->assertEquals( 0, did_action( "customize_preview_{$setting->type}" ) ); // only applicable for custom types (not options or theme_mods)
$this->assertEquals( $initial_value, call_user_func( $type_options['getter'], $name ) );
$this->assertEquals( $initial_value, $setting->value() );
// @todo What if we call the setter after preview() is called? If no post_value, should the new set value be stored? If that happens, then the following 3 assertions should be inverted
$overridden_value = "overridden_value_$name";
call_user_func( $type_options['setter'], $name, $overridden_value );
$this->assertEquals( $initial_value, call_user_func( $type_options['getter'], $name ) );
$this->assertEquals( $initial_value, $setting->value() );
$this->assertNotEquals( $overridden_value, $setting->value() );
// Non-multidimensional: Test unset setting being overridden by a post value
$name = "unset_{$type}_overridden";
$default = "default_value_{$name}";
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
$this->assertEquals( $this->undefined, call_user_func( $type_options['getter'], $name, $this->undefined ) );
$this->assertEquals( $default, $setting->value() );
$setting->preview(); // activate post_data
$this->assertEquals( $this->post_data_overrides[ $name ], call_user_func( $type_options['getter'], $name, $this->undefined ) );
$this->assertEquals( $this->post_data_overrides[ $name ], $setting->value() );
// Non-multidimensional: Test set setting being overridden by a post value
$name = "set_{$type}_overridden";
$default = "default_value_{$name}";
$initial_value = "initial_value_{$name}";
call_user_func( $type_options['setter'], $name, $initial_value );
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
$this->assertEquals( $initial_value, call_user_func( $type_options['getter'], $name, $this->undefined ) );
$this->assertEquals( $initial_value, $setting->value() );
$setting->preview(); // activate post_data
$this->assertEquals( 0, did_action( "customize_preview_{$setting->id}" ) ); // only applicable for custom types (not options or theme_mods)
$this->assertEquals( 0, did_action( "customize_preview_{$setting->type}" ) ); // only applicable for custom types (not options or theme_mods)
$this->assertEquals( $this->post_data_overrides[ $name ], call_user_func( $type_options['getter'], $name, $this->undefined ) );
$this->assertEquals( $this->post_data_overrides[ $name ], $setting->value() );
}
}
/**
* Run assertions on multidimensional standard settings.
*/
function test_preview_standard_types_multidimensional() {
$_POST['customized'] = wp_slash( wp_json_encode( $this->post_data_overrides ) );
foreach ( $this->standard_type_configs as $type => $type_options ) {
// Multidimensional: See what effect the preview filter has on a non-existent setting (default value should be seen)
$base_name = "unset_{$type}_multi";
$name = $base_name . '[foo]';
$default = "default_value_{$name}";
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
$this->assertEquals( $this->undefined, call_user_func( $type_options['getter'], $base_name, $this->undefined ) );
$this->assertEquals( $default, $setting->value() );
$setting->preview();
$base_value = call_user_func( $type_options['getter'], $base_name, $this->undefined );
$this->assertArrayHasKey( 'foo', $base_value );
$this->assertEquals( $default, $base_value['foo'] );
// Multidimensional: See what effect the preview has on an extant setting (default value should not be seen)
$base_name = "set_{$type}_multi";
$name = $base_name . '[foo]';
$default = "default_value_{$name}";
$initial_value = "initial_value_{$name}";
$base_initial_value = array( 'foo' => $initial_value, 'bar' => 'persisted' );
call_user_func( $type_options['setter'], $base_name, $base_initial_value );
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
$base_value = call_user_func( $type_options['getter'], $base_name, array() );
$this->assertEquals( $initial_value, $base_value['foo'] );
$this->assertEquals( $initial_value, $setting->value() );
$setting->preview();
$this->assertEquals( 0, did_action( "customize_preview_{$setting->id}" ) ); // only applicable for custom types (not options or theme_mods)
$this->assertEquals( 0, did_action( "customize_preview_{$setting->type}" ) ); // only applicable for custom types (not options or theme_mods)
$base_value = call_user_func( $type_options['getter'], $base_name, array() );
$this->assertEquals( $initial_value, $base_value['foo'] );
$this->assertEquals( $initial_value, $setting->value() );
// Multidimensional: Test unset setting being overridden by a post value
$base_name = "unset_{$type}_multi_overridden";
$name = $base_name . '[foo]';
$default = "default_value_{$name}";
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
$this->assertEquals( $this->undefined, call_user_func( $type_options['getter'], $base_name, $this->undefined ) );
$this->assertEquals( $default, $setting->value() );
$setting->preview();
$this->assertEquals( 0, did_action( "customize_preview_{$setting->id}" ) ); // only applicable for custom types (not options or theme_mods)
$this->assertEquals( 0, did_action( "customize_preview_{$setting->type}" ) ); // only applicable for custom types (not options or theme_mods)
$base_value = call_user_func( $type_options['getter'], $base_name, $this->undefined );
$this->assertArrayHasKey( 'foo', $base_value );
$this->assertEquals( $this->post_data_overrides[ $name ], $base_value['foo'] );
// Multidimemsional: Test set setting being overridden by a post value
$base_name = "set_{$type}_multi_overridden";
$name = $base_name . '[foo]';
$default = "default_value_{$name}";
$initial_value = "initial_value_{$name}";
$base_initial_value = array( 'foo' => $initial_value, 'bar' => 'persisted' );
call_user_func( $type_options['setter'], $base_name, $base_initial_value );
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
$base_value = call_user_func( $type_options['getter'], $base_name, $this->undefined );
$this->arrayHasKey( 'foo', $base_value );
$this->arrayHasKey( 'bar', $base_value );
$this->assertEquals( $base_initial_value['foo'], $base_value['foo'] );
$getter = call_user_func( $type_options['getter'], $base_name, $this->undefined );
$this->assertEquals( $base_initial_value['bar'], $getter['bar'] );
$this->assertEquals( $initial_value, $setting->value() );
$setting->preview();
$this->assertEquals( 0, did_action( "customize_preview_{$setting->id}" ) ); // only applicable for custom types (not options or theme_mods)
$this->assertEquals( 0, did_action( "customize_preview_{$setting->type}" ) ); // only applicable for custom types (not options or theme_mods)
$base_value = call_user_func( $type_options['getter'], $base_name, $this->undefined );
$this->assertArrayHasKey( 'foo', $base_value );
$this->assertEquals( $this->post_data_overrides[ $name ], $base_value['foo'] );
$this->arrayHasKey( 'bar', call_user_func( $type_options['getter'], $base_name, $this->undefined ) );
$getter = call_user_func( $type_options['getter'], $base_name, $this->undefined );
$this->assertEquals( $base_initial_value['bar'], $getter['bar'] );
}
}
/**
* @var array storage for saved custom type data that are tested in self::test_preview_custom_type()
*/
protected $custom_type_data_saved;
/**
* @var array storage for previewed custom type data that are tested in self::test_preview_custom_type()
*/
protected $custom_type_data_previewed;
function custom_type_getter( $name, $default = null ) {
if ( did_action( "customize_preview_{$name}" ) && array_key_exists( $name, $this->custom_type_data_previewed ) ) {
$value = $this->custom_type_data_previewed[ $name ];
} else if ( array_key_exists( $name, $this->custom_type_data_saved ) ) {
$value = $this->custom_type_data_saved[ $name ];
} else {
$value = $default;
}
return $value;
}
function custom_type_setter( $name, $value ) {
$this->custom_type_data_saved[ $name ] = $value;
}
function custom_type_value_filter( $default ) {
$name = preg_replace( '/^customize_value_/', '', current_filter() );
return $this->custom_type_getter( $name, $default );
}
/**
* @param WP_Customize_Setting $setting
*/
function custom_type_preview( $setting ) {
$previewed_value = $setting->post_value( $this->undefined );
if ( $this->undefined !== $previewed_value ) {
$this->custom_type_data_previewed[ $setting->id ] = $previewed_value;
}
}
function test_preview_custom_type() {
$type = 'custom_type';
$post_data_overrides = array(
"unset_{$type}_with_post_value" => "unset_{$type}_without_post_value",
"set_{$type}_with_post_value" => "set_{$type}_without_post_value",
);
$_POST['customized'] = wp_slash( wp_json_encode( $post_data_overrides ) );
$this->custom_type_data_saved = array();
$this->custom_type_data_previewed = array();
add_action( "customize_preview_{$type}", array( $this, 'custom_type_preview' ) );
// Custom type not existing and no post value override
$name = "unset_{$type}_without_post_value";
$default = "default_value_{$name}";
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
// Note: #29316 will allow us to have one filter for all settings of a given type, which is what we need
add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ) );
$this->assertEquals( $this->undefined, $this->custom_type_getter( $name, $this->undefined ) );
$this->assertEquals( $default, $setting->value() );
$setting->preview();
$this->assertEquals( 1, did_action( "customize_preview_{$setting->id}" ) );
$this->assertEquals( 1, did_action( "customize_preview_{$setting->type}" ) );
$this->assertEquals( $this->undefined, $this->custom_type_getter( $name, $this->undefined ) ); // Note: for a non-custom type this is $default
$this->assertEquals( $default, $setting->value() ); // should be same as above
// Custom type existing and no post value override
$name = "set_{$type}_without_post_value";
$default = "default_value_{$name}";
$initial_value = "initial_value_{$name}";
$this->custom_type_setter( $name, $initial_value );
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
// Note: #29316 will allow us to have one filter for all settings of a given type, which is what we need
add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ) );
$this->assertEquals( $initial_value, $this->custom_type_getter( $name, $this->undefined ) );
$this->assertEquals( $initial_value, $setting->value() );
$setting->preview();
$this->assertEquals( 1, did_action( "customize_preview_{$setting->id}" ) );
$this->assertEquals( 2, did_action( "customize_preview_{$setting->type}" ) );
$this->assertEquals( $initial_value, $this->custom_type_getter( $name, $this->undefined ) ); // should be same as above
$this->assertEquals( $initial_value, $setting->value() ); // should be same as above
// Custom type not existing and with a post value override
$name = "unset_{$type}_with_post_value";
$default = "default_value_{$name}";
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
// Note: #29316 will allow us to have one filter for all settings of a given type, which is what we need
add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ) );
$this->assertEquals( $this->undefined, $this->custom_type_getter( $name, $this->undefined ) );
$this->assertEquals( $default, $setting->value() );
$setting->preview();
$this->assertEquals( 1, did_action( "customize_preview_{$setting->id}" ) );
$this->assertEquals( 3, did_action( "customize_preview_{$setting->type}" ) );
$this->assertEquals( $post_data_overrides[ $name ], $this->custom_type_getter( $name, $this->undefined ) );
$this->assertEquals( $post_data_overrides[ $name ], $setting->value() );
// Custom type not existing and with a post value override
$name = "set_{$type}_with_post_value";
$default = "default_value_{$name}";
$initial_value = "initial_value_{$name}";
$this->custom_type_setter( $name, $initial_value );
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
// Note: #29316 will allow us to have one filter for all settings of a given type, which is what we need
add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ) );
$this->assertEquals( $initial_value, $this->custom_type_getter( $name, $this->undefined ) );
$this->assertEquals( $initial_value, $setting->value() );
$setting->preview();
$this->assertEquals( 1, did_action( "customize_preview_{$setting->id}" ) );
$this->assertEquals( 4, did_action( "customize_preview_{$setting->type}" ) );
$this->assertEquals( $post_data_overrides[ $name ], $this->custom_type_getter( $name, $this->undefined ) );
$this->assertEquals( $post_data_overrides[ $name ], $setting->value() );
unset( $this->custom_type_data_previewed, $this->custom_type_data_saved );
}
/**
* Test specific fix for setting's default value not applying on preview window
*
* @ticket 30988
*/
function test_non_posted_setting_applying_default_value_in_preview() {
$type = 'option';
$name = 'unset_option_without_post_value';
$default = "default_value_{$name}";
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
$this->assertEquals( $this->undefined, get_option( $name, $this->undefined ) );
$this->assertEquals( $default, $setting->value() );
$setting->preview();
$this->assertEquals( $default, get_option( $name, $this->undefined ), sprintf( 'Expected get_option(%s) to return setting default: %s.', $name, $default ) );
$this->assertEquals( $default, $setting->value() );
}
/**
* Ensure that is_current_blog_previewed returns the expected values.
*
* This is applicable to both single and multisite. This doesn't do switch_to_blog()
*
* @ticket 31428
*/
function test_is_current_blog_previewed() {
$type = 'option';
$name = 'blogname';
$post_value = rand_str();
$this->manager->set_post_value( $name, $post_value );
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type' ) );
$this->assertNull( $setting->is_current_blog_previewed() );
$setting->preview();
$this->assertTrue( $setting->is_current_blog_previewed() );
$this->assertEquals( $post_value, $setting->value() );
$this->assertEquals( $post_value, get_option( $name ) );
}
/**
* Ensure that previewing a setting is disabled when the current blog is switched.
*
* @ticket 31428
* @group multisite
*/
function test_previewing_with_switch_to_blog() {
if ( ! is_multisite() ) {
$this->markTestSkipped( 'Cannot test WP_Customize_Setting::is_current_blog_previewed() with switch_to_blog() if not on multisite.' );
}
$type = 'option';
$name = 'blogdescription';
$post_value = rand_str();
$this->manager->set_post_value( $name, $post_value );
$setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type' ) );
$this->assertNull( $setting->is_current_blog_previewed() );
$setting->preview();
$this->assertTrue( $setting->is_current_blog_previewed() );
$blog_id = $this->factory->blog->create();
switch_to_blog( $blog_id );
$this->assertFalse( $setting->is_current_blog_previewed() );
$this->assertNotEquals( $post_value, $setting->value() );
$this->assertNotEquals( $post_value, get_option( $name ) );
restore_current_blog();
}
}