<!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>[19944] trunk/wp-admin/includes/screen.php: Add WP_Screen methods get_help_tabs(), get_help_tab( $id ), get_help_sidebar().</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, #logmsg > ol { margin-left: 0; 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/19944">19944</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2012-02-17 23:40:02 +0000 (Fri, 17 Feb 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add WP_Screen methods get_help_tabs(), get_help_tab( $id ), get_help_sidebar(). Store help tabs by tab ID, not numeric key; allows proper removal with remove_help_tab( $id ). props BenChapman, npetetin for initial getter patch. fixes <a href="http://core.trac.wordpress.org/ticket/19974">#19974</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludesscreenphp">trunk/wp-admin/includes/screen.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludesscreenphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/screen.php (19943 => 19944)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/screen.php 2012-02-17 23:19:52 UTC (rev 19943)
+++ trunk/wp-admin/includes/screen.php 2012-02-17 23:40:02 UTC (rev 19944)
</span><span class="lines">@@ -580,6 +580,31 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Gets the help tabs registered for the screen.
+ *
+ * @since 3.4.0
+ *
+ * @return array Help tabs with arguments.
+ */
+ public function get_help_tabs() {
+ return $this->_help_tabs;
+ }
+
+ /**
+ * Gets the arguments for a help tab.
+ *
+ * @since 3.4.0
+ *
+ * @param string $id Help Tab ID.
+ * @return array Help tab arguments.
+ */
+ public function get_help_tab( $id ) {
+ if ( ! isset( $this->_help_tabs[ $id ] ) )
+ return null;
+ return $this->_help_tabs[ $id ];
+ }
+
+ /**
</ins><span class="cx"> * Add a help tab to the contextual help for the screen.
</span><span class="cx"> * Call this on the load-$pagenow hook for the relevant screen.
</span><span class="cx"> *
</span><span class="lines">@@ -607,7 +632,8 @@
</span><span class="cx"> if ( ! $args['id'] || ! $args['title'] )
</span><span class="cx"> return;
</span><span class="cx">
</span><del>- $this->_help_tabs[] = $args;
</del><ins>+ // Allows for overriding an existing tab with that ID.
+ $this->_help_tabs[ $args['id'] ] = $args;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -631,6 +657,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Gets the content from a contextual help sidebar.
+ *
+ * @since 3.4.0
+ *
+ */
+ public function get_help_sidebar() {
+ return $this->_help_sidebar;
+ }
+
+ /**
</ins><span class="cx"> * Add a sidebar to the contextual help for the screen.
</span><span class="cx"> * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add a sidebar to the contextual help.
</span><span class="cx"> *
</span><span class="lines">@@ -658,7 +694,7 @@
</span><span class="cx"> $old_help = apply_filters( 'contextual_help', $old_help, $this->id, $this );
</span><span class="cx">
</span><span class="cx"> // Default help only if there is no old-style block of text and no new-style help tabs.
</span><del>- if ( empty( $old_help ) && empty( $this->_help_tabs ) ) {
</del><ins>+ if ( empty( $old_help ) && ! $this->get_help_tabs() ) {
</ins><span class="cx"> $default_help = apply_filters( 'default_contextual_help', '' );
</span><span class="cx"> if ( $default_help )
</span><span class="cx"> $old_help = '<p>' . $default_help . '</p>';
</span><span class="lines">@@ -672,10 +708,10 @@
</span><span class="cx"> ) );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $has_sidebar = ! empty( $this->_help_sidebar );
</del><ins>+ $help_sidebar = $this->get_help_sidebar();
</ins><span class="cx">
</span><span class="cx"> $help_class = 'hidden';
</span><del>- if ( ! $has_sidebar )
</del><ins>+ if ( ! $help_sidebar )
</ins><span class="cx"> $help_class .= ' no-sidebar';
</span><span class="cx">
</span><span class="cx"> // Time to render!
</span><span class="lines">@@ -687,35 +723,39 @@
</span><span class="cx"> <div id="contextual-help-columns">
</span><span class="cx"> <div class="contextual-help-tabs">
</span><span class="cx"> <ul>
</span><del>- <?php foreach ( $this->_help_tabs as $i => $tab ):
</del><ins>+ <?php
+ $class = ' class="active"';
+ foreach ( $this->get_help_tabs() as $tab ) :
</ins><span class="cx"> $link_id = "tab-link-{$tab['id']}";
</span><span class="cx"> $panel_id = "tab-panel-{$tab['id']}";
</span><del>- $classes = ( $i == 0 ) ? 'active' : '';
</del><span class="cx"> ?>
</span><span class="cx">
</span><del>- <li id="<?php echo esc_attr( $link_id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
</del><ins>+ <li id="<?php echo esc_attr( $link_id ); ?>"<?php echo $class; ?>">
</ins><span class="cx"> <a href="<?php echo esc_url( "#$panel_id" ); ?>">
</span><span class="cx"> <?php echo esc_html( $tab['title'] ); ?>
</span><span class="cx"> </a>
</span><span class="cx"> </li>
</span><del>- <?php endforeach; ?>
</del><ins>+ <?php
+ $class = '';
+ endforeach;
+ ?>
</ins><span class="cx"> </ul>
</span><span class="cx"> </div>
</span><span class="cx">
</span><del>- <?php if ( $has_sidebar ) : ?>
</del><ins>+ <?php if ( $help_sidebar ) : ?>
</ins><span class="cx"> <div class="contextual-help-sidebar">
</span><del>- <?php echo $this->_help_sidebar; ?>
</del><ins>+ <?php echo $help_sidebar; ?>
</ins><span class="cx"> </div>
</span><span class="cx"> <?php endif; ?>
</span><span class="cx">
</span><span class="cx"> <div class="contextual-help-tabs-wrap">
</span><del>- <?php foreach ( $this->_help_tabs as $i => $tab ):
</del><ins>+ <?php
+ $classes = 'help-tab-content active';
+ foreach ( $this->get_help_tabs() as $tab ):
</ins><span class="cx"> $panel_id = "tab-panel-{$tab['id']}";
</span><del>- $classes = ( $i == 0 ) ? 'active' : '';
- $classes .= ' help-tab-content';
</del><span class="cx"> ?>
</span><span class="cx">
</span><del>- <div id="<?php echo esc_attr( $panel_id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
</del><ins>+ <div id="<?php echo esc_attr( $panel_id ); ?>" class="<?php echo $classes; ?>">
</ins><span class="cx"> <?php
</span><span class="cx"> // Print tab content.
</span><span class="cx"> echo $tab['content'];
</span><span class="lines">@@ -725,7 +765,10 @@
</span><span class="cx"> call_user_func_array( $tab['callback'], array( $this, $tab ) );
</span><span class="cx"> ?>
</span><span class="cx"> </div>
</span><del>- <?php endforeach; ?>
</del><ins>+ <?php
+ $classes = 'help-tab-content';
+ endforeach;
+ ?>
</ins><span class="cx"> </div>
</span><span class="cx"> </div>
</span><span class="cx"> </div>
</span><span class="lines">@@ -736,11 +779,11 @@
</span><span class="cx"> ?>
</span><span class="cx"> </div>
</span><span class="cx"> <?php
</span><del>- if ( ! $this->_help_tabs && ! $this->show_screen_options() )
</del><ins>+ if ( ! $this->get_help_tabs() && ! $this->show_screen_options() )
</ins><span class="cx"> return;
</span><span class="cx"> ?>
</span><span class="cx"> <div id="screen-meta-links">
</span><del>- <?php if ( $this->_help_tabs ) : ?>
</del><ins>+ <?php if ( $this->get_help_tabs() ) : ?>
</ins><span class="cx"> <div id="contextual-help-link-wrap" class="hide-if-no-js screen-meta-toggle">
</span><span class="cx"> <a href="#contextual-help-wrap" id="contextual-help-link" class="show-settings"><?php _e( 'Help' ); ?></a>
</span><span class="cx"> </div>
</span></span></pre>
</div>
</div>
</body>
</html>