WP_Screen::add_help_tab │ public │ WP 3.3.0

Adds a help tab to the contextual help for the 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.

Method of the class: WP_Screen{}

No Hooks.

Returns

null. Nothing (null).

Usage

$WP_Screen = new WP_Screen();
$WP_Screen->add_help_tab( $args );

$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 and should be unique for this menu. It is NOT allowed to contain any empty spaces.
  Default: false

• content(string)
  Optional. Help tab content in plain text or HTML.
  Default: empty string

• callback(callable)
  Optional. A callback to generate the tab content.
  Default: false

• priority(int)
  Optional. The priority of the tab, used for ordering.
  Default: 10

Changelog

WP_Screen::add_help_tab() WP Screen::add help tab code ^{WP 6.9.1}

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;
}