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

add_contextual_help( string $screen, string $help )

Add contextual help text for a page.


Description Description

Creates an ‘Overview’ help tab.

Top ↑

See also See also


Top ↑

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


Top ↑

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


Top ↑

Changelog Changelog

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

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by MakeWebBetter

    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

Top ↑

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