On this page
add_contextual_help( string $screen, string $help )
This function has been deprecated. Use WP_Screen::add_help_tab() instead.
Add contextual help text for a page.
Description
Creates an ‘Overview’ help tab.
See also
Parameters
$screenstring Required-
The handle for the screen to add help to. This is usually the hook name returned by the
add_*_page()functions. $helpstring Required-
The content of an
'Overview'help tab.
Source
File: wp-admin/includes/deprecated.php. View all references
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 );
}
Related
Uses
| Uses | Description |
|---|---|
| WP_Screen::add_old_compat_help() wp-admin/includes/class-wp-screen.php | Sets the old string-based contextual help for the screen for backward compatibility. |
| convert_to_screen() wp-admin/includes/template.php | Converts a screen string to a screen object. |
| _deprecated_function() wp-includes/functions.php | Marks a function as deprecated and inform when it has been used. |
Changelog
| Version | Description |
|---|---|
| 3.3.0 | Use WP_Screen::add_help_tab() |
| 2.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_contextual_help