A WordPress-centric search engine for devs and theme authors



format_for_editor ›

Since4.3.0
Deprecatedn/a
format_for_editor ( $text, $default_editor = null )
Parameters: (2)
  • (string) $text The text to be formatted.
    Required: Yes
  • (string) $default_editor The default editor for the current user. It is usually either 'html' or 'tinymce'.
    Required: No
    Default: null
See:
  • _WP_Editors::editor()
Returns:
  • (string) The formatted text after filter is applied.
Defined at:
Codex:

Formats text for the editor.

Generally the browsers treat everything inside a textarea as text, but it is still a good idea to HTML entity encode </code>, > and & in the content.

The filter {@see 'format_for_editor'} is applied here. If $text is empty the filter will be applied to an empty string.



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 );
}