Warning: This function has been deprecated. Use WP_Screen::add_help_tab() instead.
add_contextual_help() WordPress Function
The add_contextual_help() function is used to add contextual help to a WordPress admin screen. The function takes two arguments: the screen ID and the help text. The screen ID is the ID of the screen where you want to display the help text. The help text can be either a string or an array.
add_contextual_help( string $screen, string $help ) #
Add contextual help text for a page.
Description
Creates an ‘Overview’ help tab.
See also
Parameters
- $screen
(string)(Required)The handle for the screen to add help to. This is usually the hook name returned by the
add_*_page()
functions.- $help
(string)(Required)The content of an 'Overview' help tab.
Source
File: wp-admin/includes/deprecated.php
function add_contextual_help( $screen, $help ) { _deprecated_function( __FUNCTION__, '3.3.0', 'get_current_screen()->add_help_tab()' ); if ( is_string( $screen ) ) $screen = convert_to_screen( $screen ); WP_Screen::add_old_compat_help( $screen, $help ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.3.0 | Use WP_Screen::add_help_tab() |
2.7.0 | Introduced. |