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

Changelog

Version Description
3.3.0 Use WP_Screen::add_help_tab()
2.7.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_contextual_help