format_to_edit( string $content, bool $rich_text = false ): string

Description

Parameters

$contentstring

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.Default: false

Return

string

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

Hooks fired · 1

One hook fires while format_to_edit() runs, in this order:

1. 1
   apply_filters( format_to_edit )filterline 2764 (+8 into the body)

   Filters the text to be formatted for editing.

Uses · 2

• apply_filters()Calls the callback functions that have been added to a filter hook.
• esc_textarea()Escaping for textarea values.

Used by · 3

• edit_form_image_editor()Displays the image and editor in the post editor
• get_comment_to_edit()Returns a WP_Comment object based on comment ID.
• sanitize_post_field()Sanitizes a post field based on context.

Source

View on Trac ↗View on GitHub ↗

2756function format_to_edit( $content, $rich_text = false ) {2757	/**2758	 * Filters the text to be formatted for editing.2759	 *2760	 * @since 1.2.02761	 *2762	 * @param string $content The text, prior to formatting for editing.2763	 */2764	$content = apply_filters( 'format_to_edit', $content );2765	if ( ! $rich_text ) {2766		$content = esc_textarea( $content );2767	}2768	return $content;2769}

History

Introduced in 0.71. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/formatting.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.