WP_Screen::add_help_tab( array $args )
Add a help tab to the contextual help for the screen.
Description
Call this on the load-$pagenow hook for the relevant screen.
Parameters
- $args
-
(array) (Required) Array of arguments used to display the help tab.
- 'title'
(string) Title for the tab. Default false. - 'id'
(string) Tab ID. Must be HTML-safe. Default false. - 'content'
(string) Optional. Help tab content in plain text or HTML. Default empty string. - 'callback'
(string) Optional. A callback to generate the tab content. Default false. - 'priority'
(int) Optional. The priority of the tab, used for ordering. Default 10.
- 'title'
Source
File: wp-admin/includes/class-wp-screen.php
public function add_help_tab( $args ) {
$defaults = array(
'title' => false,
'id' => false,
'content' => '',
'callback' => false,
'priority' => 10,
);
$args = wp_parse_args( $args, $defaults );
$args['id'] = sanitize_html_class( $args['id'] );
// Ensure we have an ID and title.
if ( ! $args['id'] || ! $args['title'] )
return;
// Allows for overriding an existing tab with that ID.
$this->_help_tabs[ $args['id'] ] = $args;
}
Changelog
| Version | Description |
|---|---|
| WP-4.4.0 | The $priority argument was added. |
| WP-3.3.0 | Introduced. |