wp_richedit_pre

Formats text for the rich text editor.

Description

(string) wp_richedit_pre( (string) $text ); 

The filter is applied here. If $text is empty the filter will be applied to an empty string.

Returns (string)

The formatted text after filter is applied.

Parameters (1)

0. $text (string)
The text to be formatted.

Usage

  1. if ( !function_exists( 'wp_richedit_pre' ) ) { 
  2.     require_once ABSPATH . WPINC . '/deprecated.php'; 
  3. } 
  4.   
  5. // The text to be formatted. 
  6. $text = ''; 
  7.   
  8. // NOTICE! Understand what this does before running. 
  9. $result = wp_richedit_pre($text); 
  10.     

Defined (1)

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

/wp-includes/deprecated.php  
  1. function wp_richedit_pre($text) { 
  2.     _deprecated_function( __FUNCTION__, '4.3.0', 'format_for_editor()' ); 
  3.  
  4.     if ( empty( $text ) ) { 
  5.         /** 
  6.          * Filters text returned for the rich text editor. 
  7.          * 
  8.          * This filter is first evaluated, and the value returned, if an empty string 
  9.          * is passed to wp_richedit_pre(). If an empty string is passed, it results 
  10.          * in a break tag and line feed. 
  11.          * 
  12.          * If a non-empty string is passed, the filter is evaluated on the wp_richedit_pre() 
  13.          * return after being formatted. 
  14.          * 
  15.          * @since 2.0.0 
  16.          * @deprecated 4.3.0 
  17.          * 
  18.          * @param string $output Text for the rich text editor. 
  19.          */ 
  20.         return apply_filters( 'richedit_pre', '' ); 
  21.     } 
  22.  
  23.     $output = convert_chars($text); 
  24.     $output = wpautop($output); 
  25.     $output = htmlspecialchars($output, ENT_NOQUOTES, get_option( 'blog_charset' ) ); 
  26.  
  27.     /** This filter is documented in wp-includes/deprecated.php */ 
  28.     return apply_filters( 'richedit_pre', $output ); 
  29. }