add_contextual_help( string $screen, string $help )

Description

Parameters

$screenstring

The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions.

$helpstring

The content of an 'Overview' help tab.

Uses · 3

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• convert_to_screen()Converts a screen string to a screen object.
• WP_Screen::add_old_compat_help()Sets the old string-based contextual help for the screen for backward compatibility.

Used by · 1

• twentyeleven_theme_options_help()

Source

View on Trac ↗View on GitHub ↗

997function add_contextual_help( $screen, $help ) {998	_deprecated_function( __FUNCTION__, '3.3.0', 'get_current_screen()->add_help_tab()' );999 1000	if ( is_string( $screen ) )1001		$screen = convert_to_screen( $screen );1002 1003	WP_Screen::add_old_compat_help( $screen, $help );1004}

History

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.