wp_editor_settings

Filters the wp_editor() settings.

Description

apply_filters( 'wp_editor_settings', (array) $settings, (string) $editor_id ); 

Parameters (2)

0. $settings (array)
Array of editor arguments.
1. $editor_id (string)
ID for the current editor instance.

Usage

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

Defined (1)

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

/wp-includes/class-wp-editor.php  
  1. $settings = apply_filters( 'wp_editor_settings', $settings, $editor_id );