format_to_edit

函数


format_to_edit ( $content, $rich_text = false )
参数
  • (string)
    $content
    The text about to be edited.
    Required:
  • (bool)
    $rich_text
    Optional. Whether `$content` should be considered rich text, in which case it would not be passed through esc_textarea(). Default false.
    Required:
    Default: false
返回值
  • (string) The text after the filter (and possibly htmlspecialchars()) has been run.
定义位置
  • wp-includes/formatting.php
    , line 2702
引入
0.71
弃用

Acts on text which is about to be edited.

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 {@see ‘format_to_edit’} filter.

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