W3cubDocs

/WordPress

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

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

Uses

Uses Description
wp-admin/includes/class-wp-screen.php: WP_Screen::add_old_compat_help()

Sets the old string-based contextual help for the screen for backward compatibility.
wp-admin/includes/template.php: convert_to_screen()

Convert a screen string to a screen object
wp-includes/functions.php: _deprecated_function()

Mark 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–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_contextual_help