format_to_edit

Filters the text to be formatted for editing.

Description

(string) apply_filters( 'format_to_edit', (unknown) $content ); 

Unless $richedit is set, it is simply a holder for the format_to_edit filter. If $richedit is set true htmlspecialchars() will be run on the content, converting special characters to HTMl entities.

Returns (string)

The text after the filter (and possibly htmlspecialchars()) has been run.

Parameters (1)

0. $content (unknown)
The content.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/backpress/functions.formatting.php  
  1. $content = apply_filters('format_to_edit', $content);