screen_settings

Filters the screen settings text displayed in the Screen Options tab.

Description

apply_filters( 'screen_settings', (string) $this_screen_settings, (WP_Screen) $instance ); 

This filter is currently only used on the Widgets screen to enable accessibility mode.

Parameters (2)

0. $this_screen_settings (string)
The this screen settings.
1. $instance (WP_Screen)
WP_Screen object.

Usage

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

Defined (1)

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

/wp-admin/includes/class-wp-screen.php  
  1. $this->_screen_settings = apply_filters( 'screen_settings', $this->_screen_settings, $this );