Changeset 19119 for trunk/wp-admin/includes/screen.php

Timestamp:

11/02/2011 08:14:10 PM (13 years ago)

Author:

nacin

Message:

s/add_help_sidebar/set_help_sidebar/g and introduce screen->remove_help_tab($id) and screen->remove_help_tabs(). see #19020, #18785.

File:

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

trunk/wp-admin/includes/screen.php

@@ -154 +154 @@
         return;
 
-    return $current_screen->add_option( $option, $args );
+    $current_screen->add_option( $option, $args );
 }
 
@@ -598 +598 @@
     /**
      * Add a help tab 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 contextual help tabs.
+     * Call this on the load-$pagenow hook for the relevant screen.
      *
      * @since 3.3.0
@@ -628 +628 @@
 
     /**
+     * Removes a help tab from the contextual help for the screen.
+     *
+     * @since 3.3.0
+     *
+     * @param string $id The help tab ID.
+     */
+    public function remove_help_tab( $id ) {
+        unset( $this->_help_tabs[ $id ] );
+    }
+
+    /**
+     * Removes all help tabs from the contextual help for the screen.
+     *
+     * @since 3.3.0
+     */
+    public function remove_help_tabs() {
+        $this->_help_tabs = array();
+    }
+
+    /**
      * 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.
@@ -635 +655 @@
      * @param string $content Sidebar content in plain text or HTML.
      */
-    public function add_help_sidebar( $content ) {
+    public function set_help_sidebar( $content ) {
         $this->_help_sidebar = $content;
     }