the_editor

Filters the HTML markup output that displays the editor.

Description

Parameters (1)

0. $div_id_editorcontainer_textarea_rows_rows_class_cols_40_name_id_tabindex_tab_index_id_id_s_textarea_div_n — Optional. (string) => "
\n"
The div id editorcontainer textarea rows rows class cols 40 name id tabindex tab index id id s textarea div n.

Usage

To run the hook, copy the example below.
  1. $div_id_editorcontainer_textarea_rows_rows_class_cols_40_name_id_tabindex_tab_index_id_id_s_textarea_div_n = apply_filters( 'the_editor', $div_id_editorcontainer_textarea_rows_rows_class_cols_40_name_id_tabindex_tab_index_id_id_s_textarea_div_n ); 
  2.  
  3. if ( !empty( $div_id_editorcontainer_textarea_rows_rows_class_cols_40_name_id_tabindex_tab_index_id_id_s_textarea_div_n ) ) { 
  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_editorcontainer_textarea_rows_rows_class_cols_40_name_id_tabindex_tab_index_id_id_s_textarea_div_n ) { 
  3. // make filter magic happen here... 
  4. return $div_id_editorcontainer_textarea_rows_rows_class_cols_40_name_id_tabindex_tab_index_id_id_s_textarea_div_n
  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).

/helpers/forms.php  
  1. $the_editor = apply_filters('the_editor', "<div id='editorcontainer'><textarea rows='$rows'$class cols='40' name='$id' tabindex='$tab_index' id='$id'>%s</textarea></div>\n");