<!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>[33985] trunk: Implement a priority system for Help Tabs to add them at specific positions.</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/33985">33985</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/33985","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-10 01:26:26 +0000 (Thu, 10 Sep 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'>Implement a priority system for Help Tabs to add them at specific positions.
Adds unit tests.
Props swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/19828">#19828</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesscreenphp">trunk/src/wp-admin/includes/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="trunksrcwpadminincludesscreenphp"></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/screen.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/screen.php 2015-09-10 01:20:58 UTC (rev 33984)
+++ trunk/src/wp-admin/includes/screen.php 2015-09-10 01:26:26 UTC (rev 33985)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -718,14 +718,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Gets the help tabs registered for the screen.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 Help tabs are ordered by their priority.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Help tabs with arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_help_tabs() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $this->_help_tabs;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $help_tabs = $this->_help_tabs;
+ uasort( $help_tabs, array( $this, '_sort_help_tabs' ) );
+ return $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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Compares the difference between the help tabs priorities.
+ *
+ * Used for help tabs sorting.
+ *
+ * @since 4.4.0
+ *
+ * @param int $tab_a The priority argument for the first tab.
+ * @param int $tab_b The priority argument for the second tab.
+ * @return int The difference between the priority arguments.
+ */
+ protected function _sort_help_tabs( $tab_a, $tab_b ) {
+ return $tab_a['priority'] - $tab_b['priority'];
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Gets the arguments for a help tab.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -744,13 +762,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Call this on the load-$pagenow hook for the relevant screen.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.3.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 The `$priority` argument was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args
- * - string - title - Title for the tab.
- * - string - id - Tab ID. Must be HTML-safe.
- * - string - content - Help tab content in plain text or HTML. Optional.
- * - callback - callback - A callback to generate the tab content. Optional.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args {
+ * Array of arguments used to display the help tab.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $title Title for the tab. Default false.
+ * @type string $id Tab ID. Must be HTML-safe. Default false.
+ * @type string $content Optional. Help tab content in plain text or HTML. Default empty string.
+ * @type string $callback Optional. A callback to generate the tab content. Default false.
+ * @type int $priority Optional. The priority of the tab, used for ordering. Default 10.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_help_tab( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -758,6 +780,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'callback' => false,
</span><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"> $args = wp_parse_args( $args, $defaults );
</span><span class="cx" style="display: block; padding: 0 10px">
</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-09-10 01:20:58 UTC (rev 33984)
+++ trunk/tests/phpunit/tests/admin/includesScreen.php 2015-09-10 01:26:26 UTC (rev 33985)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -163,7 +163,13 @@
</span><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"> $screen->add_help_tab( $tab_args );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $screen->get_help_tab( $tab ), $tab_args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( $screen->get_help_tab( $tab ), array(
+ 'id' => $tab,
+ 'title' => 'Help!',
+ 'content' => 'Some content',
+ 'callback' => false,
+ 'priority' => 10,
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $tabs = $screen->get_help_tabs();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( $tab, $tabs );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -176,6 +182,62 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 19828
+ */
+ function test_help_tabs_priority() {
+ $tab_1 = rand_str();
+ $tab_1_args = array(
+ 'id' => $tab_1,
+ 'title' => 'Help!',
+ 'content' => 'Some content',
+ 'callback' => false,
+ 'priority' => 11,
+ );
+
+ $tab_2 = rand_str();
+ $tab_2_args = array(
+ 'id' => $tab_2,
+ 'title' => 'Help!',
+ 'content' => 'Some content',
+ 'callback' => false,
+ 'priority' => 9,
+ );
+
+ $screen = get_current_screen();
+
+ // Add help tabs.
+
+ $screen->add_help_tab( $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 );
+
+ $tabs = $screen->get_help_tabs();
+ $this->assertEquals( 2, count( $tabs ) );
+ $this->assertArrayHasKey( $tab_1, $tabs );
+ $this->assertArrayHasKey( $tab_2, $tabs );
+
+ // Test priority order.
+
+ $this->assertEquals( $tabs, array(
+ $tab_2 => $tab_2_args,
+ $tab_1 => $tab_1_args,
+ ) );
+
+ $screen->remove_help_tab( $tab_1 );
+ $this->assertNull( $screen->get_help_tab( $tab_1 ) );
+ $this->assertEquals( 1, 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() ) );
+
+ $screen->remove_help_tabs();
+ $this->assertEquals( $screen->get_help_tabs(), array() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 25799
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_options() {
</span></span></pre>
</div>
</div>
</body>
</html>