format_for_editor( string $text, string $default_editor = null )
Formats text for the editor.
Description 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 See also
Parameters Parameters
- $text
-
(string) (Required) The text to be formatted.
- $default_editor
-
(string) (Optional) The default editor for the current user. It is usually either 'html' or 'tinymce'.
Default value: null
Return Return
(string) The formatted text after filter is applied.
Source Source
File: wp-includes/formatting.php
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 ); }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
4.3.0 | Introduced. |