<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[36089] trunk: Help Tab Order should be based on the Priority Argument</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/36089">36089</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/36089","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorbin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-12-25 22:43:41 +0000 (Fri, 25 Dec 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Help Tab Order should be based on the Priority Argument
<a href="https://core.trac.wordpress.org/changeset/34370">[34370]</a> 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.
Props meitar, swissspidy, jorbin
Fixes <a href="https://core.trac.wordpress.org/ticket/35215">#35215</a>. See <a href="https://core.trac.wordpress.org/ticket/33941">#33941</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpscreenphp">trunk/src/wp-admin/includes/class-wp-screen.php</a></li>
<li><a href="#trunktestsphpunittestsadminincludesScreenphp">trunk/tests/phpunit/tests/admin/includesScreen.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpscreenphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-screen.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-screen.php 2015-12-25 21:11:02 UTC (rev 36088)
+++ trunk/src/wp-admin/includes/class-wp-screen.php 2015-12-25 22:43:41 UTC (rev 36089)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -530,7 +530,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- sort( $priorities );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ksort( $priorities );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $sorted = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $priorities as $list ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsadminincludesScreenphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/includesScreen.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includesScreen.php 2015-12-25 21:11:02 UTC (rev 36088)
+++ trunk/tests/phpunit/tests/admin/includesScreen.php 2015-12-25 22:43:41 UTC (rev 36089)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,6 +2,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @group admin
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group adminScreen
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Admin_includesScreen extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px"> var $core_screens = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,54 +188,90 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_help_tabs_priority() {
</span><span class="cx" style="display: block; padding: 0 10px"> $tab_1 = rand_str();
</span><span class="cx" style="display: block; padding: 0 10px"> $tab_1_args = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'title' => 'Help!',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'id' => $tab_1,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'title' => 'Help!',
</del><span class="cx" style="display: block; padding: 0 10px"> 'content' => 'Some content',
</span><span class="cx" style="display: block; padding: 0 10px"> 'callback' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'priority' => 11,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'priority' => 10,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $tab_2 = rand_str();
</span><span class="cx" style="display: block; padding: 0 10px"> $tab_2_args = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'title' => 'Help!',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'id' => $tab_2,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'title' => 'Help!',
</del><span class="cx" style="display: block; padding: 0 10px"> 'content' => 'Some content',
</span><span class="cx" style="display: block; padding: 0 10px"> 'callback' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'priority' => 9,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'priority' => 2,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $screen = get_current_screen();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Add help tabs.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // add help tabs.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $screen->add_help_tab( $tab_1_args );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $screen->get_help_tab( $tab_1 ), $tab_1_args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertequals( $screen->get_help_tab( $tab_1 ), $tab_1_args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $screen->add_help_tab( $tab_2_args );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $screen->get_help_tab( $tab_2 ), $tab_2_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $tabs = $screen->get_help_tabs();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 2, count( $tabs ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 4, count( $tabs ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( $tab_1, $tabs );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( $tab_2, $tabs );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( $tab_3, $tabs );
+ $this->assertArrayHasKey( $tab_4, $tabs );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Test priority order.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $tabs, array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( array(
</ins><span class="cx" style="display: block; padding: 0 10px"> $tab_2 => $tab_2_args,
</span><span class="cx" style="display: block; padding: 0 10px"> $tab_1 => $tab_1_args,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $tab_4 => $tab_4_args,
+ $tab_3 => $tab_3_args,
+ ), $tabs );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $screen->remove_help_tab( $tab_1 );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( $screen->get_help_tab( $tab_1 ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 1, count( $screen->get_help_tabs() ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 3, count( $screen->get_help_tabs() ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $screen->remove_help_tab( $tab_2 );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( $screen->get_help_tab( $tab_2 ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 0, count( $screen->get_help_tabs() ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 2, count( $screen->get_help_tabs() ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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() ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $screen->remove_help_tabs();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $screen->get_help_tabs(), array() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( array(), $screen->get_help_tabs() );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>