Changeset 46590

Timestamp:

10/26/2019 12:32:20 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for WP_Screen::add_help_tab().

Props atachibana.
Fixes #48395.

File:

• trunk/src/wp-admin/includes/class-wp-screen.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-wp-screen.php

@@ -595 +595 @@
     /**
      * Add a help tab to the contextual help for the screen.
-     * Call this on the load-$pagenow hook for the relevant screen.
+     *
+     * Call this on the `load-$pagenow` hook for the relevant screen,
+     * or fetch the `$current_screen` object, or use get_current_screen()
+     * and then call the method from the object.
+     *
+     * You may need to filter `$current_screen` using an if or switch statement
+     * to prevent new help tabs from being added to ALL admin screens.
      *
      * @since 3.3.0
@@ -604 +610 @@
      *
      *     @type string $title    Title for the tab. Default false.
-     *     @type string $id       Tab ID. Must be HTML-safe. Default false.
+     *     @type string $id       Tab ID. Must be HTML-safe and should be unique for this menu.
+     *                            It is NOT allowed to contain any empty spaces. 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.