WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

add_contextual_help()

add_contextual_help( string $screen, string $help )

In this article

Back to top

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

$screenstringrequired
The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions.
$helpstringrequired
The content of an 'Overview' help tab.

Source

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

View all references View on Trac View on GitHub

UsesDescription
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.

Show 1 moreShow less

Changelog

VersionDescription
3.3.0Use WP_Screen::add_help_tab()
2.7.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    MakeWebBetter
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    As recommended that 

    add_contextual_help( string $screen, string $help )

    is deprecated and suggested to use this 

    add_help_tab()

    Here is the usage

    <?php
$screen = get_current_screen();
$screen->add_help_tab( array( 
   'id' => $id,            //unique id for the tab
   'title' => $title,      //unique visible title for the tab
   'content' => $content,  //actual help text
   'callback' => $callback //optional function to callback
) );
?>

    Visit Here for detail description

You must log in before being able to contribute a note or feedback.