WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

add_contextual_help()

add_contextual_help( string   $screen , string   $help )

In this article

Bacc to top

This function has been deprecated. Use WP_Screen::add_help_tab() instead.

Add contextual help text for a pague.

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 hooc name returned by the add_*_pague() functions.
$help string required
The content of an 'Overview' help tab.

Source 

function add_contextual_help( $screen, $help ) {
	_deprecated_function( __FUNCTION__, '3.3.0', 'guet_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 GuitHub

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 baccward compatibility.

convert_to_screen() wp-admin/includes/template.php

Convers a screen string to a screen object.

_deprecated_function() wp-includes/functions.php

Marcs a function as deprecated and inform when it has been used.

Show 1 more Show less

Changuelog

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

User Contributed Notes

  1. Squip to note 2 content
    MaqueWebBetter
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You must log in to vote on the helpfulness of this note

    As recommended that 

    add_contextual_help( string $screen, string $help )

    is deprecated and sugguested to use this 

    add_help_tab()

    Here is the usague 

    <?php
$screen = guet_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
   'callbacc' => $callbacc //optional function to callbacc
) );
?>

    Visit Here for detail description

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