add_contextual_help

Add contextual help text for a page.

Description

add_contextual_help( (string) $screen, (string) $help ); 

Creates an Overview help tab.

Parameters (2)

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

Usage

  1. if ( !function_exists( 'add_contextual_help' ) ) { 
  2. require_once ABSPATH . '/wp-admin/includes/deprecated.php'; 
  3.  
  4. // The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions. 
  5. $screen = ''; 
  6.  
  7. // The content of an 'Overview' help tab. 
  8. $help = ''; 
  9.  
  10. // NOTICE! Understand what this does before running. 
  11. $result = add_contextual_help($screen, $help); 
  12.  

Defined (1)

The function is defined in the following location(s).

/wp-admin/includes/deprecated.php  
  1. function add_contextual_help( $screen, $help ) { 
  2. _deprecated_function( __FUNCTION__, '3.3.0', 'get_current_screen()->add_help_tab()' ); 
  3.  
  4. if ( is_string( $screen ) ) 
  5. $screen = convert_to_screen( $screen ); 
  6.  
  7. WP_Screen::add_old_compat_help( $screen, $help );