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/widgets.php

    r41673 r42343  
    1313        global $wp_widget_factory, $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
    1414
    15         $wp_registered_sidebars = array();
    16         $wp_registered_widgets = array();
     15        $wp_registered_sidebars        = array();
     16        $wp_registered_widgets         = array();
    1717        $wp_registered_widget_controls = array();
    18         $wp_registered_widget_updates = array();
    19         $wp_widget_factory->widgets = array();
     18        $wp_registered_widget_updates  = array();
     19        $wp_widget_factory->widgets    = array();
    2020
    2121        parent::clean_up_global_scope();
     
    5656        $this->assertEmpty( $wp_registered_widgets );
    5757
    58         update_option( 'widget_search', array(
    59             2 => array( 'title' => '' ),
    60             '_multiwidget' => 1,
    61         ) );
    62         update_option( 'widget_better_search', array(
    63             3 => array( 'title' => '' ),
    64             '_multiwidget' => 1,
    65         ) );
    66         update_option( 'widget_best_search', array(
    67             4 => array( 'title' => '' ),
    68             '_multiwidget' => 1,
    69         ) );
     58        update_option(
     59            'widget_search', array(
     60                2              => array( 'title' => '' ),
     61                '_multiwidget' => 1,
     62            )
     63        );
     64        update_option(
     65            'widget_better_search', array(
     66                3              => array( 'title' => '' ),
     67                '_multiwidget' => 1,
     68            )
     69        );
     70        update_option(
     71            'widget_best_search', array(
     72                4              => array( 'title' => '' ),
     73                '_multiwidget' => 1,
     74            )
     75        );
    7076
    7177        register_widget( 'WP_Widget_Search' );
    7278        $this->assertArrayHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
    7379
    74         $widget_better_search = new WP_Widget_Search();
    75         $widget_better_search->id_base = 'better_search';
    76         $widget_better_search->name = 'Better Search';
    77         $widget_better_search->option_name = 'widget_' . $widget_better_search->id_base;
     80        $widget_better_search                              = new WP_Widget_Search();
     81        $widget_better_search->id_base                     = 'better_search';
     82        $widget_better_search->name                        = 'Better Search';
     83        $widget_better_search->option_name                 = 'widget_' . $widget_better_search->id_base;
    7884        $widget_better_search->widget_options['classname'] = 'widget_' . $widget_better_search->id_base;
    79         $widget_better_search->control_options['id_base'] = $widget_better_search->id_base;
     85        $widget_better_search->control_options['id_base']  = $widget_better_search->id_base;
    8086        register_widget( $widget_better_search );
    8187        $this->assertContains( $widget_better_search, $wp_widget_factory->widgets );
    8288
    83         $widget_best_search = new WP_Widget_Search();
    84         $widget_best_search->id_base = 'best_search';
    85         $widget_best_search->name = 'Best Search';
    86         $widget_best_search->option_name = 'widget_' . $widget_best_search->id_base;
     89        $widget_best_search                              = new WP_Widget_Search();
     90        $widget_best_search->id_base                     = 'best_search';
     91        $widget_best_search->name                        = 'Best Search';
     92        $widget_best_search->option_name                 = 'widget_' . $widget_best_search->id_base;
    8793        $widget_best_search->widget_options['classname'] = 'widget_' . $widget_best_search->id_base;
    88         $widget_best_search->control_options['id_base'] = $widget_best_search->id_base;
     94        $widget_best_search->control_options['id_base']  = $widget_best_search->id_base;
    8995        register_widget( $widget_best_search );
    9096        $this->assertContains( $widget_best_search, $wp_widget_factory->widgets );
     
    135141        global $wp_registered_sidebars;
    136142
    137         $result = array();
    138         $num = 3;
     143        $result  = array();
     144        $num     = 3;
    139145        $id_base = 'WP Unit Test';
    140146        register_sidebars( $num, array( 'name' => $id_base . ' %d' ) );
     
    163169        register_sidebar();
    164170
    165         $derived_sidebar_id = "sidebar-2"; // Number of sidebars in the global + 1.
     171        $derived_sidebar_id = 'sidebar-2'; // Number of sidebars in the global + 1.
    166172
    167173        $this->assertArrayHasKey( $derived_sidebar_id, $wp_registered_sidebars );
     
    180186        register_sidebar();
    181187
    182         $derived_sidebar_id = "sidebar-2"; // Number of sidebars in the global + 1.
     188        $derived_sidebar_id = 'sidebar-2'; // Number of sidebars in the global + 1.
    183189
    184190        unregister_sidebar( $derived_sidebar_id );
     
    256262        register_sidebar();
    257263
    258         $derived_sidebar_id = "sidebar-2"; // Number of sidebars in the global + 1.
     264        $derived_sidebar_id = 'sidebar-2'; // Number of sidebars in the global + 1.
    259265
    260266        add_action( 'dynamic_sidebar_before', array( $this, 'retrieve_sidebar_id' ), 10, 2 );
     
    317323        $widget = new WP_Widget_Search( 'foo', 'Foo' );
    318324        ob_start();
    319         $args = array(
     325        $args     = array(
    320326            'before_widget' => '<section>',
    321             'after_widget' => "</section>\n",
    322             'before_title' => '<h2>',
    323             'after_title' => "</h2>\n",
     327            'after_widget'  => "</section>\n",
     328            'before_title'  => '<h2>',
     329            'after_title'   => "</h2>\n",
    324330        );
    325331        $instance = array( 'title' => 'Buscar' );
     
    349355     */
    350356    function test_wp_widget_constructor() {
    351         $id_base = 'foo';
    352         $name = 'Foo';
     357        $id_base    = 'foo';
     358        $name       = 'Foo';
    353359        $foo_widget = new WP_Widget( $id_base, $name );
    354360
     
    361367        $this->assertEquals( $id_base, $foo_widget->control_options['id_base'] );
    362368
    363         $id_base = 'bar';
    364         $name = 'Bar';
    365         $widget_options = array(
     369        $id_base         = 'bar';
     370        $name            = 'Bar';
     371        $widget_options  = array(
    366372            'classname' => 'bar_classname',
    367373        );
     
    369375            'id_base' => 'bar_id_base',
    370376        );
    371         $bar_widget = new WP_Widget( $id_base, $name, $widget_options, $control_options );
     377        $bar_widget      = new WP_Widget( $id_base, $name, $widget_options, $control_options );
    372378        $this->assertEquals( $widget_options['classname'], $bar_widget->widget_options['classname'] );
    373379        $this->assertEquals( $control_options['id_base'], $bar_widget->control_options['id_base'] );
     
    377383     * @see WP_Widget::get_field_name()
    378384     * @dataProvider data_wp_widget_get_field_name
    379      *
    380385     */
    381386    function test_wp_widget_get_field_name( $expected, $value_to_test ) {
     
    399404     * }
    400405     */
    401     function data_wp_widget_get_field_name( ) {
     406    function data_wp_widget_get_field_name() {
    402407
    403408        return array(
     
    428433     * @see WP_Widget::get_field_id()
    429434     * @dataProvider data_wp_widget_get_field_id
    430      *
    431435     */
    432436    function test_wp_widget_get_field_id( $expected, $value_to_test ) {
     
    567571        $wp_widget_search = $wp_registered_widgets['search-2']['callback'][0];
    568572
    569         $settings = $wp_widget_search->get_settings();
     573        $settings         = $wp_widget_search->get_settings();
    570574        $overridden_title = 'Unit Tested';
    571575
     
    578582         * So this is why the value must be obtained.
    579583         */
    580         $instance = $settings[2];
     584        $instance          = $settings[2];
    581585        $instance['title'] = $overridden_title;
    582         $settings[2] = $instance;
     586        $settings[2]       = $instance;
    583587
    584588        $wp_widget_search->save_settings( $settings );
     
    615619        require_once ABSPATH . '/wp-admin/includes/widgets.php';
    616620        $widget_id = 'search-2';
    617         $widget = $wp_registered_widgets[ $widget_id ];
    618         $params = array(
    619             'widget_id' => $widget['id'],
     621        $widget    = $wp_registered_widgets[ $widget_id ];
     622        $params    = array(
     623            'widget_id'   => $widget['id'],
    620624            'widget_name' => $widget['name'],
    621625        );
    622         $args = wp_list_widget_controls_dynamic_sidebar( array( 0 => $params, 1 => $widget['params'][0] ) );
     626        $args      = wp_list_widget_controls_dynamic_sidebar(
     627            array(
     628                0 => $params,
     629                1 => $widget['params'][0],
     630            )
     631        );
    623632
    624633        ob_start();
     
    642651
    643652        $param_overrides = array(
    644             'before_form' => '<!-- before_form -->',
    645             'after_form' => '<!-- after_form -->',
     653            'before_form'           => '<!-- before_form -->',
     654            'after_form'            => '<!-- after_form -->',
    646655            'before_widget_content' => '<!-- before_widget_content -->',
    647             'after_widget_content' => '<!-- after_widget_content -->',
    648         );
    649         $params = array_merge( $params, $param_overrides );
    650         $args = wp_list_widget_controls_dynamic_sidebar( array( 0 => $params, 1 => $widget['params'][0] ) );
     656            'after_widget_content'  => '<!-- after_widget_content -->',
     657        );
     658        $params          = array_merge( $params, $param_overrides );
     659        $args            = wp_list_widget_controls_dynamic_sidebar(
     660            array(
     661                0 => $params,
     662                1 => $widget['params'][0],
     663            )
     664        );
    651665
    652666        ob_start();
     
    668682        the_widget(
    669683            'WP_Widget_Text',
    670             array( 'title' => 'Notes', 'text' => 'Sample text' ),
    671             array( 'before_widget' => '<span class="special %s">', 'after_widget' => '</span>' )
     684            array(
     685                'title' => 'Notes',
     686                'text'  => 'Sample text',
     687            ),
     688            array(
     689                'before_widget' => '<span class="special %s">',
     690                'after_widget'  => '</span>',
     691            )
    672692        );
    673693        $actual = ob_get_clean();
     
    713733
    714734        // Test restoring sidebars widgets when previously activated.
    715         set_theme_mod( 'sidebars_widgets', array(
    716             'time' => time(),
    717             'data' => array(
    718                 'sidebar-1' => array( 'tag_cloud-1' ),
    719                 'sidebar-2' => array(),
    720                 'sidebar-3' => array( 'unregistered_widget-1', 'text-1', 'media_image-1' ),
    721                 'orphaned_widgets_1' => array( 'media_video-2' ),
    722             ),
    723         ) );
     735        set_theme_mod(
     736            'sidebars_widgets', array(
     737                'time' => time(),
     738                'data' => array(
     739                    'sidebar-1'          => array( 'tag_cloud-1' ),
     740                    'sidebar-2'          => array(),
     741                    'sidebar-3'          => array( 'unregistered_widget-1', 'text-1', 'media_image-1' ),
     742                    'orphaned_widgets_1' => array( 'media_video-2' ),
     743                ),
     744            )
     745        );
    724746
    725747        $sidebars_widgets = array(
    726             'sidebar-1' => array( 'tag_cloud-1' ),
    727             'sidebar-2' => array( 'text-1' ),
    728             'fantasy'   => array( 'archives-2' ),
     748            'sidebar-1'           => array( 'tag_cloud-1' ),
     749            'sidebar-2'           => array( 'text-1' ),
     750            'fantasy'             => array( 'archives-2' ),
    729751            'wp_inactive_widgets' => array(),
    730752        );
     
    750772        $this->assertCount( 6, $sidebars_widgets['wp_inactive_widgets'] );
    751773
    752         $this->assertContains( 'meta-2',            $sidebars_widgets['wp_inactive_widgets'] );
    753         $this->assertContains( 'search-2',          $sidebars_widgets['wp_inactive_widgets'] );
    754         $this->assertContains( 'archives-2',        $sidebars_widgets['wp_inactive_widgets'] );
    755         $this->assertContains( 'categories-2',      $sidebars_widgets['wp_inactive_widgets'] );
    756         $this->assertContains( 'recent-posts-2',    $sidebars_widgets['wp_inactive_widgets'] );
     774        $this->assertContains( 'meta-2', $sidebars_widgets['wp_inactive_widgets'] );
     775        $this->assertContains( 'search-2', $sidebars_widgets['wp_inactive_widgets'] );
     776        $this->assertContains( 'archives-2', $sidebars_widgets['wp_inactive_widgets'] );
     777        $this->assertContains( 'categories-2', $sidebars_widgets['wp_inactive_widgets'] );
     778        $this->assertContains( 'recent-posts-2', $sidebars_widgets['wp_inactive_widgets'] );
    757779        $this->assertContains( 'recent-comments-2', $sidebars_widgets['wp_inactive_widgets'] );
    758780
     
    770792
    771793        wp_widgets_init();
    772         $this->register_sidebars( array( 'sidebar-1', 'sidebar-2','sidebar-3', 'wp_inactive_widgets' ) );
     794        $this->register_sidebars( array( 'sidebar-1', 'sidebar-2', 'sidebar-3', 'wp_inactive_widgets' ) );
    773795
    774796        $sidebars_widgets = array(
    775             'sidebar-1' => array( 'tag_cloud-1' ),
    776             'sidebar-2' => array( 'text-1' ),
    777             'sidebar-3' => array( 'custom_widget-1' ),
     797            'sidebar-1'           => array( 'tag_cloud-1' ),
     798            'sidebar-2'           => array( 'text-1' ),
     799            'sidebar-3'           => array( 'custom_widget-1' ),
    778800            'wp_inactive_widgets' => array(),
    779801        );
     
    808830
    809831        wp_widgets_init();
    810         $this->register_sidebars( array( 'sidebar-1', 'sidebar-2','sidebar-3', 'wp_inactive_widgets' ) );
     832        $this->register_sidebars( array( 'sidebar-1', 'sidebar-2', 'sidebar-3', 'wp_inactive_widgets' ) );
    811833
    812834        $sidebars_widgets = array(
    813             'sidebar-1' => array( 'tag_cloud-1' ),
    814             'sidebar-2' => array( 'text-1' ),
    815             'fantasy'   => array( 'unregistered_widget-1' ),
     835            'sidebar-1'           => array( 'tag_cloud-1' ),
     836            'sidebar-2'           => array( 'text-1' ),
     837            'fantasy'             => array( 'unregistered_widget-1' ),
    816838            'wp_inactive_widgets' => array(),
    817839        );
     
    842864        $this->assertCount( 6, $sidebars_widgets['wp_inactive_widgets'] );
    843865
    844         $this->assertContains( 'archives-2',        $sidebars_widgets['wp_inactive_widgets'] );
    845         $this->assertContains( 'meta-2',            $sidebars_widgets['wp_inactive_widgets'] );
    846         $this->assertContains( 'search-2',          $sidebars_widgets['wp_inactive_widgets'] );
    847         $this->assertContains( 'categories-2',      $sidebars_widgets['wp_inactive_widgets'] );
    848         $this->assertContains( 'recent-posts-2',    $sidebars_widgets['wp_inactive_widgets'] );
     866        $this->assertContains( 'archives-2', $sidebars_widgets['wp_inactive_widgets'] );
     867        $this->assertContains( 'meta-2', $sidebars_widgets['wp_inactive_widgets'] );
     868        $this->assertContains( 'search-2', $sidebars_widgets['wp_inactive_widgets'] );
     869        $this->assertContains( 'categories-2', $sidebars_widgets['wp_inactive_widgets'] );
     870        $this->assertContains( 'recent-posts-2', $sidebars_widgets['wp_inactive_widgets'] );
    849871        $this->assertContains( 'recent-comments-2', $sidebars_widgets['wp_inactive_widgets'] );
    850872
     
    854876        // Reset.
    855877        $sidebars_widgets = array(
    856             'sidebar-1' => array( 'tag_cloud-1' ),
    857             'sidebar-2' => array( 'text-1' ),
    858             'fantasy'   => array( 'archives-2' ),
     878            'sidebar-1'           => array( 'tag_cloud-1' ),
     879            'sidebar-2'           => array( 'text-1' ),
     880            'fantasy'             => array( 'archives-2' ),
    859881            'wp_inactive_widgets' => array(),
    860882        );
     
    881903        $this->assertCount( 6, $sidebars_widgets['wp_inactive_widgets'] );
    882904
    883         $this->assertContains( 'meta-2',            $sidebars_widgets['wp_inactive_widgets'] );
    884         $this->assertContains( 'search-2',          $sidebars_widgets['wp_inactive_widgets'] );
     905        $this->assertContains( 'meta-2', $sidebars_widgets['wp_inactive_widgets'] );
     906        $this->assertContains( 'search-2', $sidebars_widgets['wp_inactive_widgets'] );
    885907        // archives-2 ends up as inactive because fantasy sidebar doesn't exist.
    886         $this->assertContains( 'archives-2',        $sidebars_widgets['wp_inactive_widgets'] );
    887         $this->assertContains( 'categories-2',      $sidebars_widgets['wp_inactive_widgets'] );
    888         $this->assertContains( 'recent-posts-2',    $sidebars_widgets['wp_inactive_widgets'] );
     908        $this->assertContains( 'archives-2', $sidebars_widgets['wp_inactive_widgets'] );
     909        $this->assertContains( 'categories-2', $sidebars_widgets['wp_inactive_widgets'] );
     910        $this->assertContains( 'recent-posts-2', $sidebars_widgets['wp_inactive_widgets'] );
    889911        $this->assertContains( 'recent-comments-2', $sidebars_widgets['wp_inactive_widgets'] );
    890912
     
    902924
    903925        wp_widgets_init();
    904         $this->register_sidebars( array( 'sidebar-1', 'sidebar-2','sidebar-3', 'wp_inactive_widgets' ) );
     926        $this->register_sidebars( array( 'sidebar-1', 'sidebar-2', 'sidebar-3', 'wp_inactive_widgets' ) );
    905927
    906928        $old_sidebars_widgets = array(
    907             'sidebar-1' => array( 'tag_cloud-1' ),
    908             'sidebar-2' => array( 'text-1' ),
    909             'sidebar-3' => array( 'unregistered_widget-1' ),
    910             'fantasy'   => array( 'archives-2' ),
     929            'sidebar-1'           => array( 'tag_cloud-1' ),
     930            'sidebar-2'           => array( 'text-1' ),
     931            'sidebar-3'           => array( 'unregistered_widget-1' ),
     932            'fantasy'             => array( 'archives-2' ),
    911933            'wp_inactive_widgets' => array(),
    912934        );
     
    929951        $this->assertCount( 6, $sidebars_widgets['wp_inactive_widgets'] );
    930952
    931         $this->assertContains( 'meta-2',            $sidebars_widgets['wp_inactive_widgets'] );
    932         $this->assertContains( 'search-2',          $sidebars_widgets['wp_inactive_widgets'] );
    933         $this->assertContains( 'archives-2',        $sidebars_widgets['wp_inactive_widgets'] );
    934         $this->assertContains( 'categories-2',      $sidebars_widgets['wp_inactive_widgets'] );
    935         $this->assertContains( 'recent-posts-2',    $sidebars_widgets['wp_inactive_widgets'] );
     953        $this->assertContains( 'meta-2', $sidebars_widgets['wp_inactive_widgets'] );
     954        $this->assertContains( 'search-2', $sidebars_widgets['wp_inactive_widgets'] );
     955        $this->assertContains( 'archives-2', $sidebars_widgets['wp_inactive_widgets'] );
     956        $this->assertContains( 'categories-2', $sidebars_widgets['wp_inactive_widgets'] );
     957        $this->assertContains( 'recent-posts-2', $sidebars_widgets['wp_inactive_widgets'] );
    936958        $this->assertContains( 'recent-comments-2', $sidebars_widgets['wp_inactive_widgets'] );
    937959
     
    955977
    956978        $sidebars_widgets = array(
    957             'sidebar-1' => array( 'tag_cloud-1' ),
     979            'sidebar-1'           => array( 'tag_cloud-1' ),
    958980            'wp_inactive_widgets' => array(),
    959981        );
     
    977999
    9781000        $sidebars_widgets = array(
    979             'sidebar-1' => array( 'tag_cloud-1' ),
    980             'sidebar-2' => array( 'text-1' ),
     1001            'sidebar-1'           => array( 'tag_cloud-1' ),
     1002            'sidebar-2'           => array( 'text-1' ),
    9811003            'wp_inactive_widgets' => array( 'search-2', 'archives-2' ),
    9821004            'orphaned_widgets_1'  => array( 'calendar-1' ),
     
    10071029    public function test__wp_remove_unregistered_widgets() {
    10081030        $widgets = array(
    1009             'sidebar-1' => array( 'tag_cloud-1' ),
    1010             'sidebar-2' => array( 'text-1' ),
    1011             'fantasy'   => array( 'archives-2' ),
     1031            'sidebar-1'           => array( 'tag_cloud-1' ),
     1032            'sidebar-2'           => array( 'text-1' ),
     1033            'fantasy'             => array( 'archives-2' ),
    10121034            'wp_inactive_widgets' => array(),
    1013             'array_version' => 3,
     1035            'array_version'       => 3,
    10141036        );
    10151037
     
    10441066
    10451067        $expected_sidebars = array(
    1046             'primary' => 1,
     1068            'primary'             => 1,
    10471069            'wp_inactive_widgets' => array(),
    10481070        );
     
    10581080        $this->register_sidebars( array( 'primary', 'secondary' ) );
    10591081        $prev_theme_sidebars = array(
    1060             'primary' => 1,
    1061             'secondary' => 2,
     1082            'primary'             => 1,
     1083            'secondary'           => 2,
    10621084            'wp_inactive_widgets' => array(),
    10631085        );
     
    10841106
    10851107        $expected_sidebars = array(
    1086             'primary' => array(),
    1087             'secondary' => array(),
     1108            'primary'             => array(),
     1109            'secondary'           => array(),
    10881110            'wp_inactive_widgets' => array(),
    10891111        );
     
    10991121        $this->register_sidebars( array( 'primary' ) );
    11001122        $prev_theme_sidebars = array(
    1101             'top-menu' => array(),
     1123            'top-menu'  => array(),
    11021124            'secondary' => array(),
    11031125        );
     
    11061128
    11071129        $expected_sidebars = array(
    1108             'main' => array(),
     1130            'main'                => array(),
    11091131            'wp_inactive_widgets' => array(),
    11101132        );
     
    11221144        $prev_theme_sidebars = array(
    11231145            'navigation-menu' => array(),
    1124             'top-menu' => array(),
     1146            'top-menu'        => array(),
    11251147        );
    11261148
     
    11281150
    11291151        $expected_sidebars = array(
    1130             'main' => array(),
    1131             'primary' => array(),
     1152            'main'                => array(),
     1153            'primary'             => array(),
    11321154            'wp_inactive_widgets' => array(),
    11331155        );
Note: See TracChangeset for help on using the changeset viewer.