WP_Screen::add_help_tab

Advertisement

Summery Summery

Add a help tab to the contextual help for the screen.

Syntax Syntax

WP_Screen::add_help_tab( array $args )

Description Description

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.

Parameters 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 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'
    (string) Optional. A callback to generate the tab content. Default false.
  • 'priority'
    (int) Optional. The priority of the tab, used for ordering. Default 10.

Source Source

File: wp-admin/includes/class-wp-screen.php


			

Advertisement

Changelog Changelog

Changelog
Version Description
4.4.0 The $priority argument was added.
3.3.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.