Changeset 36104 for branches/4.4

Timestamp:

12/27/2015 02:13:20 AM (9 years ago)

Author:

dd32

Message:

Help Tab Order should be based on the Priority Argument

[34370] made the order that tabs are returned respect the order they are added, however it broke the respect of priority. By using a ksort instead of a sort, we can restore that default behavior. This adjusts the unit tests so that both order added and priority are tested.

Merges [36089] to the 4.4 branch.
Props meitar, swissspidy, jorbin
Fixes #35215. See #33941.

Location:

branches/4.4

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/class-wp-screen.php (modified) (1 diff)
• tests/phpunit/tests/admin/includesScreen.php (modified) (2 diffs)

branches/4.4/src/wp-admin/includes/class-wp-screen.php

@@ -531 +531 @@
         }
 
-        sort( $priorities );
+        ksort( $priorities );
 
         $sorted = array();

branches/4.4/tests/phpunit/tests/admin/includesScreen.php

@@ -3 +3 @@
 /**
  * @group admin
+ * @group adminScreen
  */
 class Tests_Admin_includesScreen extends WP_UnitTestCase {
@@ -188 +189 @@
         $tab_1      = rand_str();
         $tab_1_args = array(
+            'title'    => 'Help!',
             'id'       => $tab_1,
-            'title'    => 'Help!',
             'content'  => 'Some content',
             'callback' => false,
-            'priority' => 11,
+            'priority' => 10,
         );
 
         $tab_2      = rand_str();
         $tab_2_args = array(
+            'title'    => 'Help!',
             'id'       => $tab_2,
-            'title'    => 'Help!',
             'content'  => 'Some content',
             'callback' => false,
-            'priority' => 9,
+            'priority' => 2,
+        );
+        $tab_3      = rand_str();
+        $tab_3_args = array(
+            'title'    => 'help!',
+            'id'       => $tab_3,
+            'content'  => 'some content',
+            'callback' => false,
+            'priority' => 40,
+        );
+        $tab_4      = rand_str();
+        $tab_4_args = array(
+            'title'    => 'help!',
+            'id'       => $tab_4,
+            'content'  => 'some content',
+            'callback' => false,
+            // Don't include a priority
         );
 
         $screen = get_current_screen();
 
-        // Add help tabs.
+        // add help tabs.
 
         $screen->add_help_tab( $tab_1_args );
-        $this->assertEquals( $screen->get_help_tab( $tab_1 ), $tab_1_args );
+        $this->assertequals( $screen->get_help_tab( $tab_1 ), $tab_1_args );
 
         $screen->add_help_tab( $tab_2_args );
         $this->assertEquals( $screen->get_help_tab( $tab_2 ), $tab_2_args );
 
+        $screen->add_help_tab( $tab_3_args );
+        $this->assertEquals( $screen->get_help_tab( $tab_3 ), $tab_3_args );
+
+        $screen->add_help_tab( $tab_4_args );
+        // Priority is added with the default for future calls
+        $tab_4_args[ 'priority' ] = 10;
+        $this->assertEquals( $screen->get_help_tab( $tab_4 ), $tab_4_args );
+
         $tabs = $screen->get_help_tabs();
-        $this->assertEquals( 2, count( $tabs ) );
+        $this->assertEquals( 4, count( $tabs ) );
         $this->assertArrayHasKey( $tab_1, $tabs );
         $this->assertArrayHasKey( $tab_2, $tabs );
+        $this->assertArrayHasKey( $tab_3, $tabs );
+        $this->assertArrayHasKey( $tab_4, $tabs );
 
         // Test priority order.
 
-        $this->assertEquals( $tabs, array(
+        $this->assertSame( array(
             $tab_2 => $tab_2_args,
             $tab_1 => $tab_1_args,
-        ) );
+            $tab_4 => $tab_4_args,
+            $tab_3 => $tab_3_args,
+        ), $tabs );
 
         $screen->remove_help_tab( $tab_1 );
         $this->assertNull( $screen->get_help_tab( $tab_1 ) );
-        $this->assertEquals( 1, count( $screen->get_help_tabs() ) );
+        $this->assertSame( 3, count( $screen->get_help_tabs() ) );
 
         $screen->remove_help_tab( $tab_2 );
         $this->assertNull( $screen->get_help_tab( $tab_2 ) );
-        $this->assertEquals( 0, count( $screen->get_help_tabs() ) );
+        $this->assertSame( 2, count( $screen->get_help_tabs() ) );
+
+        $screen->remove_help_tab( $tab_3 );
+        $this->assertNull( $screen->get_help_tab( $tab_3 ) );
+        $this->assertSame( 1, count( $screen->get_help_tabs() ) );
+
+        $screen->remove_help_tab( $tab_4 );
+        $this->assertNull( $screen->get_help_tab( $tab_4 ) );
+        $this->assertSame( 0, count( $screen->get_help_tabs() ) );
 
         $screen->remove_help_tabs();
-        $this->assertEquals( $screen->get_help_tabs(), array() );
+        $this->assertEquals( array(), $screen->get_help_tabs() );
     }