the_editor

Filters the HTML markup output that displays the editor.

Description

Parameters (1)

0. $div_id_wp_editor_id_attr_editor_container_class_wp_editor_container_quicktags_toolbar_textarea_editor_class_height_tabindex_autocomplete_cols_40_name_esc_attr_set_textarea_name_id_editor_id_attr_s_textarea_div — Optional. (string) => '
' . $quicktags_toolbar . '%s
'
The div id wp editor id attr editor container class wp editor container quicktags toolbar textarea editor class height tabindex autocomplete cols 40 name esc attr set textarea name id editor id attr s textarea div.

Usage

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

Defined (1)

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

/wp-includes/class-wp-editor.php  
  1. $the_editor = apply_filters( 'the_editor', '<div id="wp-' . $editor_id_attr . '-editor-container" class="wp-editor-container">' .