Make WordPress Core


Ignore:
Timestamp:
11/30/2017 11:09:33 PM (8 years ago)
Author:
pento
Message:

Code is Poetry.
WordPress' code just... wasn't.
This is now dealt with.

Props jrf, pento, netweb, GaryJ, jdgrimes, westonruter, Greg Sherwood from PHPCS, and everyone who's ever contributed to WPCS and PHPCS.
Fixes #41057.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/tests/customize/setting.php

    r40564 r42343  
    2222        require_once( ABSPATH . WPINC . '/class-wp-customize-manager.php' );
    2323        $GLOBALS['wp_customize'] = new WP_Customize_Manager();
    24         $this->manager = $GLOBALS['wp_customize'];
    25         $this->undefined = new stdClass();
     24        $this->manager           = $GLOBALS['wp_customize'];
     25        $this->undefined         = new stdClass();
    2626    }
    2727
     
    9090
    9191    function test_constructor_with_args() {
    92         $args = array(
    93             'type' => 'option',
    94             'capability' => 'edit_posts',
    95             'theme_supports' => 'widgets',
    96             'default' => 'barbar',
    97             'transport' => 'postMessage',
    98             'validate_callback' => array( $this, 'validate_callback_for_tests' ),
    99             'sanitize_callback' => array( $this, 'sanitize_callback_for_tests' ),
     92        $args    = array(
     93            'type'                 => 'option',
     94            'capability'           => 'edit_posts',
     95            'theme_supports'       => 'widgets',
     96            'default'              => 'barbar',
     97            'transport'            => 'postMessage',
     98            'validate_callback'    => array( $this, 'validate_callback_for_tests' ),
     99            'sanitize_callback'    => array( $this, 'sanitize_callback_for_tests' ),
    100100            'sanitize_js_callback' => array( $this, 'sanitize_js_callback_for_tests' ),
    101101        );
     
    111111
    112112    public $post_data_overrides = array(
    113         'unset_option_overridden' => 'unset_option_post_override_value\\o/',
    114         'unset_theme_mod_overridden' => 'unset_theme_mod_post_override_value\\o/',
    115         'set_option_overridden' => 'set_option_post_override_value\\o/',
    116         'set_theme_mod_overridden' => 'set_theme_mod_post_override_value\\o/',
    117         'unset_option_multi_overridden[foo]' => 'unset_option_multi_overridden[foo]_post_override_value\\o/',
     113        'unset_option_overridden'               => 'unset_option_post_override_value\\o/',
     114        'unset_theme_mod_overridden'            => 'unset_theme_mod_post_override_value\\o/',
     115        'set_option_overridden'                 => 'set_option_post_override_value\\o/',
     116        'set_theme_mod_overridden'              => 'set_theme_mod_post_override_value\\o/',
     117        'unset_option_multi_overridden[foo]'    => 'unset_option_multi_overridden[foo]_post_override_value\\o/',
    118118        'unset_theme_mod_multi_overridden[foo]' => 'unset_theme_mod_multi_overridden[foo]_post_override_value\\o/',
    119         'set_option_multi_overridden[foo]' => 'set_option_multi_overridden[foo]_post_override_value\\o/',
    120         'set_theme_mod_multi_overridden[foo]' => 'set_theme_mod_multi_overridden[foo]_post_override_value\\o/',
     119        'set_option_multi_overridden[foo]'      => 'set_option_multi_overridden[foo]_post_override_value\\o/',
     120        'set_theme_mod_multi_overridden[foo]'   => 'set_theme_mod_multi_overridden[foo]_post_override_value\\o/',
    121121    );
    122122
    123123    public $standard_type_configs = array(
    124         'option' => array(
     124        'option'    => array(
    125125            'getter' => 'get_option',
    126126            'setter' => 'update_option',
     
    144144        foreach ( $this->standard_type_configs as $type => $type_options ) {
    145145            // Non-multidimensional: See what effect the preview filter has on a non-existent setting (default value should be seen).
    146             $name = "unset_{$type}_without_post_value";
     146            $name    = "unset_{$type}_without_post_value";
    147147            $default = "default_value_{$name}";
    148148            $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
     
    154154
    155155            // Non-multidimensional: See what effect the preview has on an extant setting (default value should not be seen).
    156             $name = "set_{$type}_without_post_value";
    157             $default = "default_value_{$name}";
     156            $name          = "set_{$type}_without_post_value";
     157            $default       = "default_value_{$name}";
    158158            $initial_value = "initial_value_{$name}";
    159159            call_user_func( $type_options['setter'], $name, $initial_value );
     
    185185
    186186            // Non-multidimensional: Test unset setting being overridden by a post value.
    187             $name = "unset_{$type}_overridden";
     187            $name    = "unset_{$type}_overridden";
    188188            $default = "default_value_{$name}";
    189189            $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
     
    195195
    196196            // Non-multidimensional: Test set setting being overridden by a post value.
    197             $name = "set_{$type}_overridden";
    198             $default = "default_value_{$name}";
     197            $name          = "set_{$type}_overridden";
     198            $default       = "default_value_{$name}";
    199199            $initial_value = "initial_value_{$name}";
    200200            call_user_func( $type_options['setter'], $name, $initial_value );
     
    223223            // Multidimensional: See what effect the preview filter has on a non-existent setting (default value should be seen).
    224224            $base_name = "unset_{$type}_multi";
    225             $name = $base_name . '[foo]';
    226             $default = "default_value_{$name}";
    227             $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
     225            $name      = $base_name . '[foo]';
     226            $default   = "default_value_{$name}";
     227            $setting   = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
    228228            $this->assertEquals( $this->undefined, call_user_func( $type_options['getter'], $base_name, $this->undefined ) );
    229229            $this->assertEquals( $default, $setting->value() );
     
    234234
    235235            // Multidimensional: See what effect the preview has on an extant setting (default value should not be seen) without post value.
    236             $base_name = "set_{$type}_multi";
    237             $name = $base_name . '[foo]';
    238             $default = "default_value_{$name}";
    239             $initial_value = "initial_value_{$name}";
    240             $base_initial_value = array( 'foo' => $initial_value, 'bar' => 'persisted' );
     236            $base_name          = "set_{$type}_multi";
     237            $name               = $base_name . '[foo]';
     238            $default            = "default_value_{$name}";
     239            $initial_value      = "initial_value_{$name}";
     240            $base_initial_value = array(
     241                'foo' => $initial_value,
     242                'bar' => 'persisted',
     243            );
    241244            call_user_func( $type_options['setter'], $base_name, $base_initial_value );
    242             $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
     245            $setting    = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
    243246            $base_value = call_user_func( $type_options['getter'], $base_name, array() );
    244247            $this->assertEquals( $initial_value, $base_value['foo'] );
     
    260263            // Multidimensional: Test unset setting being overridden by a post value.
    261264            $base_name = "unset_{$type}_multi_overridden";
    262             $name = $base_name . '[foo]';
    263             $default = "default_value_{$name}";
    264             $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
     265            $name      = $base_name . '[foo]';
     266            $default   = "default_value_{$name}";
     267            $setting   = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
    265268            $this->assertEquals( $this->undefined, call_user_func( $type_options['getter'], $base_name, $this->undefined ) );
    266269            $this->assertEquals( $default, $setting->value() );
     
    273276
    274277            // Multidimensional: Test set setting being overridden by a post value.
    275             $base_name = "set_{$type}_multi_overridden";
    276             $name = $base_name . '[foo]';
    277             $default = "default_value_{$name}";
    278             $initial_value = "initial_value_{$name}";
    279             $base_initial_value = array( 'foo' => $initial_value, 'bar' => 'persisted' );
     278            $base_name          = "set_{$type}_multi_overridden";
     279            $name               = $base_name . '[foo]';
     280            $default            = "default_value_{$name}";
     281            $initial_value      = "initial_value_{$name}";
     282            $base_initial_value = array(
     283                'foo' => $initial_value,
     284                'bar' => 'persisted',
     285            );
    280286            call_user_func( $type_options['setter'], $base_name, $base_initial_value );
    281             $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
     287            $setting    = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
    282288            $base_value = call_user_func( $type_options['getter'], $base_name, $this->undefined );
    283289            $this->assertArrayHasKey( 'foo', $base_value );
     
    314320        if ( did_action( "customize_preview_{$name}" ) && array_key_exists( $name, $this->custom_type_data_previewed ) ) {
    315321            $value = $this->custom_type_data_previewed[ $name ];
    316         } else if ( array_key_exists( $name, $this->custom_type_data_saved ) ) {
     322        } elseif ( array_key_exists( $name, $this->custom_type_data_saved ) ) {
    317323            $value = $this->custom_type_data_saved[ $name ];
    318324        } else {
     
    358364    function test_preview_custom_type() {
    359365        wp_set_current_user( $this->factory()->user->create( array( 'role' => 'administrator' ) ) );
    360         $type = 'custom_type';
     366        $type                = 'custom_type';
    361367        $post_data_overrides = array(
    362368            "unset_{$type}_with_post_value" => "unset_{$type}_without_post_value\\o/",
    363             "set_{$type}_with_post_value" => "set_{$type}_without_post_value\\o/",
     369            "set_{$type}_with_post_value"   => "set_{$type}_without_post_value\\o/",
    364370        );
    365371        $_POST['customized'] = wp_slash( wp_json_encode( $post_data_overrides ) );
    366372
    367         $this->custom_type_data_saved = array();
     373        $this->custom_type_data_saved     = array();
    368374        $this->custom_type_data_previewed = array();
    369375
     
    371377
    372378        // Custom type not existing and no post value override.
    373         $name = "unset_{$type}_without_post_value";
     379        $name    = "unset_{$type}_without_post_value";
    374380        $default = "default_value_{$name}";
    375381        $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
     
    385391
    386392        // Custom type existing and no post value override.
    387         $name = "set_{$type}_without_post_value";
    388         $default = "default_value_{$name}";
     393        $name          = "set_{$type}_without_post_value";
     394        $default       = "default_value_{$name}";
    389395        $initial_value = "initial_value_{$name}";
    390396        $this->custom_type_setter( $name, $initial_value );
     
    407413
    408414        // Custom type not existing and with a post value override.
    409         $name = "unset_{$type}_with_post_value";
     415        $name    = "unset_{$type}_with_post_value";
    410416        $default = "default_value_{$name}";
    411417        $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
     
    421427
    422428        // Custom type not existing and with a post value override.
    423         $name = "set_{$type}_with_post_value";
    424         $default = "default_value_{$name}";
     429        $name          = "set_{$type}_with_post_value";
     430        $default       = "default_value_{$name}";
    425431        $initial_value = "initial_value_{$name}";
    426432        $this->custom_type_setter( $name, $initial_value );
     
    438444        // Custom type that does not handle supplying the post value from the customize_value_{$id_base} filter.
    439445        $setting_id = 'custom_without_previewing_value_filter';
    440         $setting = $this->manager->add_setting( $setting_id, array(
    441             'type' => 'custom_preview_test',
    442             'default' => 123,
    443             'sanitize_callback' => array( $this->manager->nav_menus, 'intval_base10' ),
    444         ) );
     446        $setting    = $this->manager->add_setting(
     447            $setting_id, array(
     448                'type'              => 'custom_preview_test',
     449                'default'           => 123,
     450                'sanitize_callback' => array( $this->manager->nav_menus, 'intval_base10' ),
     451            )
     452        );
    445453
    446454        /*
     
    466474     */
    467475    function test_non_posted_setting_applying_default_value_in_preview() {
    468         $type = 'option';
    469         $name = 'unset_option_without_post_value';
     476        $type    = 'option';
     477        $name    = 'unset_option_without_post_value';
    470478        $default = "default_value_{$name}";
    471479        $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
     
    484492     */
    485493    function test_update_custom_type() {
    486         $type = 'custom';
    487         $name = 'foo';
     494        $type    = 'custom';
     495        $name    = 'foo';
    488496        $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type' ) );
    489497        $this->manager->add_setting( $setting );
     
    544552    function test_is_current_blog_previewed() {
    545553        wp_set_current_user( $this->factory()->user->create( array( 'role' => 'administrator' ) ) );
    546         $type = 'option';
    547         $name = 'blogname';
     554        $type       = 'option';
     555        $name       = 'blogname';
    548556        $post_value = __FUNCTION__;
    549557        $this->manager->set_post_value( $name, $post_value );
     
    566574    function test_previewing_with_switch_to_blog() {
    567575        wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
    568         $type = 'option';
    569         $name = 'blogdescription';
     576        $type       = 'option';
     577        $name       = 'blogdescription';
    570578        $post_value = __FUNCTION__;
    571579        $this->manager->set_post_value( $name, $post_value );
     
    590598        wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
    591599
    592         $name = 'autoloaded1';
    593         $setting = new WP_Customize_Setting( $this->manager, $name, array(
    594             'type' => 'option',
    595         ) );
    596         $value = 'value1';
     600        $name    = 'autoloaded1';
     601        $setting = new WP_Customize_Setting(
     602            $this->manager, $name, array(
     603                'type' => 'option',
     604            )
     605        );
     606        $value   = 'value1';
    597607        $this->manager->set_post_value( $setting->id, $value );
    598608        $setting->save();
     
    601611        $this->assertEquals( $value, get_option( $name ) );
    602612
    603         $name = 'autoloaded2';
    604         $setting = new WP_Customize_Setting( $this->manager, $name, array(
    605             'type' => 'option',
    606             'autoload' => true,
    607         ) );
    608         $value = 'value2';
     613        $name    = 'autoloaded2';
     614        $setting = new WP_Customize_Setting(
     615            $this->manager, $name, array(
     616                'type'     => 'option',
     617                'autoload' => true,
     618            )
     619        );
     620        $value   = 'value2';
    609621        $this->manager->set_post_value( $setting->id, $value );
    610622        $setting->save();
     
    613625        $this->assertEquals( $value, get_option( $name ) );
    614626
    615         $name = 'not-autoloaded1';
    616         $setting = new WP_Customize_Setting( $this->manager, $name, array(
    617             'type' => 'option',
    618             'autoload' => false,
    619         ) );
    620         $value = 'value3';
     627        $name    = 'not-autoloaded1';
     628        $setting = new WP_Customize_Setting(
     629            $this->manager, $name, array(
     630                'type'     => 'option',
     631                'autoload' => false,
     632            )
     633        );
     634        $value   = 'value3';
    621635        $this->manager->set_post_value( $setting->id, $value );
    622636        $setting->save();
     
    625639        $this->assertEquals( $value, get_option( $name ) );
    626640
    627         $id_base = 'multi-not-autoloaded';
    628         $setting1 = new WP_Customize_Setting( $this->manager, $id_base . '[foo]', array(
    629             'type' => 'option',
    630         ) );
    631         $setting2 = new WP_Customize_Setting( $this->manager, $id_base . '[bar]', array(
    632             'type' => 'option',
    633             'autoload' => false,
    634         ) );
     641        $id_base  = 'multi-not-autoloaded';
     642        $setting1 = new WP_Customize_Setting(
     643            $this->manager, $id_base . '[foo]', array(
     644                'type' => 'option',
     645            )
     646        );
     647        $setting2 = new WP_Customize_Setting(
     648            $this->manager, $id_base . '[bar]', array(
     649                'type'     => 'option',
     650                'autoload' => false,
     651            )
     652        );
    635653        $this->manager->set_post_value( $setting1->id, 'value1' );
    636654        $this->manager->set_post_value( $setting2->id, 'value2' );
     
    648666    public function test_js_value() {
    649667        $default = "\x00";
    650         $args = array(
    651             'type' => 'binary',
    652             'default' => $default,
    653             'transport' => 'postMessage',
    654             'dirty' => true,
     668        $args    = array(
     669            'type'                 => 'binary',
     670            'default'              => $default,
     671            'transport'            => 'postMessage',
     672            'dirty'                => true,
    655673            'sanitize_js_callback' => array( $this, 'sanitize_js_callback_base64_for_testing' ),
    656674        );
     
    677695     */
    678696    public function test_validate() {
    679         $setting = new WP_Customize_Setting( $this->manager, 'name', array(
    680             'type' => 'key',
    681             'validate_callback' => array( $this, 'filter_validate_for_test_validate' ),
    682         ) );
     697        $setting  = new WP_Customize_Setting(
     698            $this->manager, 'name', array(
     699                'type'              => 'key',
     700                'validate_callback' => array( $this, 'filter_validate_for_test_validate' ),
     701            )
     702        );
    683703        $validity = $setting->validate( 'BAD!' );
    684704        $this->assertInstanceOf( 'WP_Error', $validity );
     
    715735
    716736        $initial_value = 456;
    717         set_theme_mod( 'nav_menu_locations', array(
    718             'primary' => $initial_value,
    719         ) );
     737        set_theme_mod(
     738            'nav_menu_locations', array(
     739                'primary' => $initial_value,
     740            )
     741        );
    720742        $setting_id = 'nav_menu_locations[primary]';
    721743
Note: See TracChangeset for help on using the changeset viewer.