format_to_edit() WordPress Function
The format_to_edit() function is used to format a string for editing in a text area. This function is especially useful for ensuring that line breaks are retained in a string when it is edited in a text area.
format_to_edit( string $content, bool $rich_text = false ) #
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
- $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
(string) The text after the filter (and possibly htmlspecialchars()) has been run.
Source
File: wp-includes/formatting.php
2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 | 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 codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.4.0 | The $richedit parameter was renamed to $rich_text for clarity. |
| 0.71 | Introduced. |