From d4909682974061c33c625dcd3a5bc0adba233c55 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sat, 26 Oct 2019 00:32:20 +0000 Subject: [PATCH] Docs: Improve documentation for `WP_Screen::add_help_tab()`. Props atachibana. Fixes #48395. git-svn-id: https://develop.svn.wordpress.org/trunk@46590 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-wp-screen.php | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/wp-admin/includes/class-wp-screen.php b/src/wp-admin/includes/class-wp-screen.php index 41b20a1024..ec1cf917c3 100644 --- a/src/wp-admin/includes/class-wp-screen.php +++ b/src/wp-admin/includes/class-wp-screen.php @@ -594,7 +594,13 @@ final class WP_Screen { /** * 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 * @since 4.4.0 The `$priority` argument was added. @@ -603,7 +609,8 @@ final class WP_Screen { * Array of arguments used to display the help tab. * * @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. * @type int $priority Optional. The priority of the tab, used for ordering. Default 10.