WordPress at a glance
function is not described

format_to_edit() WP 0.71

Acts on text which is about to be edited.

The $content is run through esc_textarea(), which uses htmlspecialchars() to convert special characters to HTML entities. If $richedit is set to true, it is simply a holder for the 'format_to_edit' filter.

  • Since 4.4.0 The $richedit parameter was renamed to $rich_text for clarity.
Hooks in function
Return

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

Usage

format_to_edit( $content, $rich_text );
$content(string) (required)
The text about to be edited.
$rich_text(true/false)
Whether $content should be considered rich text, in which case it would not be passed through esc_textarea().
Default: false

Code of format to edit: wp-includes/formatting.php VER 5.0.3

<?php
function format_to_edit( $content, $rich_text = false ) {
	/**
	 * Filters the text to be formatted for editing.
	 *
	 * @since 1.2.0
	 *
	 * @param string $content The text, prior to formatting for editing.
	 */
	$content = apply_filters( 'format_to_edit', $content );
	if ( ! $rich_text )
		$content = esc_textarea( $content );
	return $content;
}