Formats text for the editor.
Description
Generally the browsers treat everything inside a textarea as text, but it is still a good idea to HTML entity encode <
, >
and &
in the content.
The filter ‘format_for_editor’ is applied here. If $text
is empty the filter will be applied to an empty string.
See also
Parameters
$text
stringrequired- The text to be formatted.
$default_editor
stringoptional- The default editor for the current user.
It is usually either'html'
or'tinymce'
.Default:
null
Source
function format_for_editor( $text, $default_editor = null ) {
if ( $text ) {
$text = htmlspecialchars( $text, ENT_NOQUOTES, get_option( 'blog_charset' ) );
}
/**
* Filters the text after it is formatted for the editor.
*
* @since 4.3.0
*
* @param string $text The formatted text.
* @param string $default_editor The default editor for the current user.
* It is usually either 'html' or 'tinymce'.
*/
return apply_filters( 'format_for_editor', $text, $default_editor );
}
Hooks
- apply_filters( ‘format_for_editor’,
string $text ,string $default_editor ) Filters the text after it is formatted for the editor.
Changelog
Version | Description |
---|---|
4.3.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.