W3cubDocs

/WordPress

format_for_editor( string $text, string $default_editor = null )

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.

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

(string) The formatted text after filter is applied.

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

Uses

Uses	Description
wp-includes/formatting.php: format_for_editor	Filters the text after it is formatted for the editor.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/option.php: get_option()	Retrieves an option value based on an option name.

Changelog

Version	Description
4.3.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/format_for_editor