format_to_edit( string $content, bool $rich_text = false )
Acts on text which is about to be edited.
Description 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 Parameters
- $content
-
(string) (Required) The text about to be edited.
- $rich_text
-
(bool) (Optional) Whether
$contentshould be considered rich text, in which case it would not be passed through esc_textarea().Default value: false
Return Return
(string) The text after the filter (and possibly htmlspecialchars()) has been run.
Source Source
File: wp-includes/formatting.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;
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 4.4.0 | The $richedit parameter was renamed to $rich_text for clarity. |
| 0.71 | Introduced. |