WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/format to edit

Description

Acts on text which is about to be edited.

Unless $richedit is set, it is simply a holder for the 'format_to_edit' filter. If $richedit is set true htmlspecialchars will be run on the content, converting special characters to HTML entities.

Usage

<?php format_to_edit$content$richedit ?>

Parameters

$content
(string) (required) The text about to be edited.
Default: None
$richedit
(boolean) (optional) Whether or not the $content should pass through htmlspecialchars.
Default: false

Return Values

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

Examples

Notes

Change Log

Since: 0.71

Source File

format_to_edit() is located in wp-includes/formatting.php.

Related

See also index of Function Reference and index of Template Tags.