Changeset 18941

Timestamp:

10/11/2011 07:29:09 PM (14 years ago)

Author:

nacin

Message:

Enforce IDs for add_help_tab(). props mbijon. Restore default_contextual_help, for now. see #18785.

Location:

trunk/wp-admin

Files:

• edit-form-advanced.php (modified) (3 diffs)
• includes/screen.php (modified) (4 diffs)
• index.php (modified) (3 diffs)

trunk/wp-admin/edit-form-advanced.php

@@ -190 +190 @@
 
     $current_screen->add_help_tab( array(
+        'id'      => 'publish-box',
         'title'   => __('Publish Box'),
         'content' => $publish_box,
@@ -198 +199 @@
 
     $current_screen->add_help_tab( array(
+        'id'      => 'discussion-settings',
         'title'   => __('Discussion Settings'),
         'content' => $discussion_settings,
@@ -209 +211 @@
     );
 } elseif ( 'page' == $post_type ) {
-    $current_screen->add_help_tab( 'about-pages', __('About Pages'), '<p>' . __('Pages are similar to Posts in that they have a title, body text, and associated metadata, but they are different in that they are not part of the chronological blog stream, kind of like permanent posts. Pages are not categorized or tagged, but can have a hierarchy. You can nest Pages under other Pages by making one the &#8220;Parent&#8221; of the other, creating a group of Pages.') . '</p>' .
-                '<p>' . __('Creating a Page is very similar to creating a Post, and the screens can be customized in the same way using drag and drop, the Screen Options tab, and expanding/collapsing boxes as you choose. This screen also has the new in 3.2 distraction-free writing space, available in both the Visual and HTML modes via the Fullscreen buttons. The Page editor mostly works the same as the Post editor, but there are some Page-specific features in the Page Attributes box:') . '</p>' );
-    $current_screen->add_help_tab('page-attributes', ('Page Attributes'),
-                '<p>' . __('<strong>Parent</strong> - You can arrange your pages in hierarchies. For example, you could have an &#8220;About&#8221; page that has &#8220;Life Story&#8221; and &#8220;My Dog&#8221; pages under it. There are no limits to how many levels you can nest pages.') . '</p>' .
-                '<p>' . __('<strong>Template</strong> - Some themes have custom templates you can use for certain pages that might have additional features or custom layouts. If so, you&#8217;ll see them in this dropdown menu.') . '</p>' .
-                '<p>' . __('<strong>Order</strong> - Pages are usually ordered alphabetically, but you can choose your own order by entering a number (1 for first, etc.) in this field.') . '</p>' );
+    $about_pages = '<p>' . __('Pages are similar to Posts in that they have a title, body text, and associated metadata, but they are different in that they are not part of the chronological blog stream, kind of like permanent posts. Pages are not categorized or tagged, but can have a hierarchy. You can nest Pages under other Pages by making one the &#8220;Parent&#8221; of the other, creating a group of Pages.') . '</p>' .
+        '<p>' . __('Creating a Page is very similar to creating a Post, and the screens can be customized in the same way using drag and drop, the Screen Options tab, and expanding/collapsing boxes as you choose. This screen also has the new in 3.2 distraction-free writing space, available in both the Visual and HTML modes via the Fullscreen buttons. The Page editor mostly works the same as the Post editor, but there are some Page-specific features in the Page Attributes box:') . '</p>';
+    
+    $current_screen->add_help_tab( array(
+        'id'      => 'about-pages',
+        'title'   => __('About Pages'),
+        'content' => $about_pages,
+    ) );
+    
+    $page_attributes = '<p>' . __('<strong>Parent</strong> - You can arrange your pages in hierarchies. For example, you could have an &#8220;About&#8221; page that has &#8220;Life Story&#8221; and &#8220;My Dog&#8221; pages under it. There are no limits to how many levels you can nest pages.') . '</p>' .
+        '<p>' . __('<strong>Template</strong> - Some themes have custom templates you can use for certain pages that might have additional features or custom layouts. If so, you&#8217;ll see them in this dropdown menu.') . '</p>' .
+        '<p>' . __('<strong>Order</strong> - Pages are usually ordered alphabetically, but you can choose your own order by entering a number (1 for first, etc.) in this field.') . '</p>';
+    
+    $current_screen->add_help_tab( array(
+        'id' => 'page-attributes',
+        'title' => __('Page Attributes'),
+        'content' => $page_attributes,
+    ) );
+    
     $current_screen->add_help_sidebar(
             '<p><strong>' . __('For more information:') . '</strong></p>' .

trunk/wp-admin/includes/screen.php

@@ -591 +591 @@
      * @param array $args
      * - string   - title    - Title for the tab.
-     * - string   - id       - Tab ID. Optional.
+     * - 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.
@@ -605 +605 @@
         $args = wp_parse_args( $args, $defaults );
 
-        // Ensure we have a title.
-        if ( ! $args['title'] )
+        $args['id'] = sanitize_html_class( $args['id'] );
+
+        // Ensure we have an ID and title.
+        if ( ! $args['id'] || ! $args['title'] )
             return;
-
-        // Create an id from the title if one is not provided.
-        if ( ! $args['id'] )
-            $args['id'] = sanitize_html_class( $args['title'] );
 
         $this->_help_tabs[] = $args;
@@ -643 +641 @@
         $_wp_contextual_help = apply_filters( 'contextual_help_list', $_wp_contextual_help, $this );
 
-        if ( isset( $_wp_contextual_help[ $this->id ] ) ) {
+        if ( isset( $_wp_contextual_help[ $this->id ] ) || ! $this->_help_tabs ) {
             // Call old contextual_help filter.
-            $contextual_help = apply_filters( 'contextual_help', $_wp_contextual_help[ $this->id ], $this->id, $this );
+            if ( isset( $_wp_contextual_help[ $this->id ] ) )
+                $contextual_help = apply_filters( 'contextual_help', $_wp_contextual_help[ $this->id ], $this->id, $this );
+
+            if ( empty( $contextual_help ) ) {
+                $default_help = __( '<a href="http://codex.wordpress.org/" target="_blank">Documentation</a>' );
+                $default_help .= '<br />';
+                $default_help .= __( '<a href="http://wordpress.org/support/" target="_blank">Support Forums</a>' );
+                $contextual_help = '<p>' . apply_filters( 'default_contextual_help', $default_help ) . '</p>';
+            }
 
             $this->add_help_tab( array(
+                'id'      => 'contextual-help',
                 'title'   => __('Screen Info'),
                 'content' => $contextual_help,
@@ -656 +663 @@
         if ( $this->show_screen_options() ) {
             $this->add_help_tab( array(
+                'id'       => 'screen-options',
                 'title'    => __('Screen Options'),
                 'callback' => array( $this, 'render_screen_options' ),

trunk/wp-admin/index.php

@@ -37 +37 @@
 
 $current_screen->add_help_tab( array(
+        'id'      => 'help-navigation',
     'title'   => __('Navigation'),
     'content' => $help_navigation,
@@ -47 +48 @@
 
 $current_screen->add_help_tab( array(
+        'id'      => 'help-layout',
     'title'   => __('Layout'),
     'content' => $help_layout,
@@ -62 +64 @@
 
 $current_screen->add_help_tab( array(
+        'id'      => 'help-content',
     'title'   => __('Content'),
     'content' => $help_content,