Acts on text which is about to be edited.

Description

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.

Parameters

$contentstringrequired

The text about to be edited.

$rich_textbooloptional

Whether $content should be considered rich text, in which case it would not be passed through esc_textarea() .

Default:false

Return

Source

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

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘format_to_edit’, string $content )

Filters the text to be formatted for editing.

Changelog