contextual_help_list

Filters the legacy contextual help list.

Description

apply_filters( 'contextual_help_list', (array) $self_old_compat_help, (WP_Screen) $instance ); 

Parameters (2)

0. $self_old_compat_help (array) => self::$_old_compat_help
The self old compat help.
1. $instance (WP_Screen)
Current WP_Screen instance.

Usage

To run the hook, copy the example below.
  1. $self_old_compat_help = apply_filters( 'contextual_help_list', $self_old_compat_help, $instance ); 
  2.  
  3. if ( !empty( $self_old_compat_help ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the contextual_help_list callback 
  2. function filter_contextual_help_list( $self_old_compat_help, $instance ) { 
  3. // make filter magic happen here... 
  4. return $self_old_compat_help
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'contextual_help_list', 'filter_contextual_help_list', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'contextual_help_list', 'filter_contextual_help_list', 10, 2 ); 

Defined (1)

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

/wp-admin/includes/class-wp-screen.php  
  1. self::$_old_compat_help = apply_filters( 'contextual_help_list', self::$_old_compat_help, $this );