sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
Props atachibana.
Fixes #48395.

git-svn-id: https://develop.svn.wordpress.org/trunk@46590 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2019-10-26 00:32:20 +00:00
parent 354fc5cba0
commit d490968297
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/wp-admin/includes/class-wp-screen.php
View File

@ -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.