Changeset 19944

Timestamp:

02/17/2012 11:40:02 PM (13 years ago)

Author:

nacin

Message:

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 #19974.

File:

• trunk/wp-admin/includes/screen.php (modified) (8 diffs)

trunk/wp-admin/includes/screen.php

@@ -581 +581 @@
 
     /**
+     * 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 ];
+    }
+
+    /**
      * Add a help tab to the contextual help for the screen.
      * Call this on the load-$pagenow hook for the relevant screen.
@@ -608 +633 @@
             return;
 
-        $this->_help_tabs[] = $args;
+        // Allows for overriding an existing tab with that ID.
+        $this->_help_tabs[ $args['id'] ] = $args;
     }
 
@@ -632 +658 @@
 
     /**
+     * Gets the content from a contextual help sidebar.
+     *
+     * @since 3.4.0
+     *
+     */
+    public function get_help_sidebar() {
+        return $this->_help_sidebar;
+    }
+    
+    /**
      * Add a sidebar to the contextual help for the screen.
      * 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.
@@ -659 +695 @@
 
         // Default help only if there is no old-style block of text and no new-style help tabs.
-        if ( empty( $old_help ) && empty( $this->_help_tabs ) ) {
+        if ( empty( $old_help ) && ! $this->get_help_tabs() ) {
             $default_help = apply_filters( 'default_contextual_help', '' );
             if ( $default_help )
@@ -673 +709 @@
         }
 
-        $has_sidebar = ! empty( $this->_help_sidebar );
+        $help_sidebar = $this->get_help_sidebar();
 
         $help_class = 'hidden';
-        if ( ! $has_sidebar )
+        if ( ! $help_sidebar )
             $help_class .= ' no-sidebar';
 
@@ -688 +724 @@
                     <div class="contextual-help-tabs">
                         <ul>
-                        <?php foreach ( $this->_help_tabs as $i => $tab ):
+                        <?php
+                        $class = ' class="active"';
+                        foreach ( $this->get_help_tabs() as $tab ) :
                             $link_id  = "tab-link-{$tab['id']}";
                             $panel_id = "tab-panel-{$tab['id']}";
-                            $classes  = ( $i == 0 ) ? 'active' : '';
                             ?>
 
-                            <li id="<?php echo esc_attr( $link_id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
+                            <li id="<?php echo esc_attr( $link_id ); ?>"<?php echo $class; ?>">
                                 <a href="<?php echo esc_url( "#$panel_id" ); ?>">
                                     <?php echo esc_html( $tab['title'] ); ?>
                                 </a>
                             </li>
-                        <?php endforeach; ?>
+                        <?php
+                            $class = '';
+                        endforeach;
+                        ?>
                         </ul>
                     </div>
 
-                    <?php if ( $has_sidebar ) : ?>
+                    <?php if ( $help_sidebar ) : ?>
                     <div class="contextual-help-sidebar">
-                        <?php echo $this->_help_sidebar; ?>
+                        <?php echo $help_sidebar; ?>
                     </div>
                     <?php endif; ?>
 
                     <div class="contextual-help-tabs-wrap">
-                        <?php foreach ( $this->_help_tabs as $i => $tab ):
+                        <?php
+                        $classes = 'help-tab-content active';
+                        foreach ( $this->get_help_tabs() as $tab ):
                             $panel_id = "tab-panel-{$tab['id']}";
-                            $classes  = ( $i == 0 ) ? 'active' : '';
-                            $classes .= ' help-tab-content';
                             ?>
 
-                            <div id="<?php echo esc_attr( $panel_id ); ?>" class="<?php echo esc_attr( $classes ); ?>">
+                            <div id="<?php echo esc_attr( $panel_id ); ?>" class="<?php echo $classes; ?>">
                                 <?php
                                 // Print tab content.
@@ -726 +766 @@
                                 ?>
                             </div>
-                        <?php endforeach; ?>
+                        <?php
+                            $classes = 'help-tab-content';
+                        endforeach;
+                        ?>
                     </div>
                 </div>
@@ -737 +780 @@
         </div>
         <?php
-        if ( ! $this->_help_tabs && ! $this->show_screen_options() )
+        if ( ! $this->get_help_tabs() && ! $this->show_screen_options() )
             return;
         ?>
         <div id="screen-meta-links">
-        <?php if ( $this->_help_tabs ) : ?>
+        <?php if ( $this->get_help_tabs() ) : ?>
             <div id="contextual-help-link-wrap" class="hide-if-no-js screen-meta-toggle">
             <a href="#contextual-help-wrap" id="contextual-help-link" class="show-settings"><?php _e( 'Help' ); ?></a>