sanitize_textarea_field()

💡 云策文档标注

概述

sanitize_textarea_field() 函数用于对来自用户输入或数据库的多行字符串进行清理，类似于 sanitize_text_field()，但保留换行符（n）和其他空白字符，这些在 textarea 元素中是合法输入。

关键要点

函数 sanitize_textarea_field() 清理多行字符串，保留换行符和空白。
参数 $str 为必需字符串，返回清理后的字符串。
内部使用 _sanitize_text_fields() 辅助函数，并通过 apply_filters() 提供钩子 'sanitize_textarea_field' 以过滤结果。
自 WordPress 4.7.0 版本引入，常用于 REST API 的 rest_sanitize_value_from_schema() 函数中。

代码示例

function sanitize_textarea_field( $str ) {
	$filtered = _sanitize_text_fields( $str, true );

	/**
	 * Filters a sanitized textarea field string.
	 *
	 * @since 4.7.0
	 *
	 * @param string $filtered The sanitized string.
	 * @param string $str      The string prior to being sanitized.
	 */
	return apply_filters( 'sanitize_textarea_field', $filtered, $str );
}

📄 原文内容

Sanitizes a multiline string from user input or from the database.

Description

The function is like sanitize_text_field() , but preserves new lines (n) and other whitespace, which are legitimate input in textarea elements.

Parameters

$strstringrequired: String to sanitize.

Return

string Sanitized string.

Source

function sanitize_textarea_field( $str ) {
	$filtered = _sanitize_text_fields( $str, true );

	/**
	 * Filters a sanitized textarea field string.
	 *
	 * @since 4.7.0
	 *
	 * @param string $filtered The sanitized string.
	 * @param string $str      The string prior to being sanitized.
	 */
	return apply_filters( 'sanitize_textarea_field', $filtered, $str );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘sanitize_textarea_field’, string $filtered, string $str ): Filters a sanitized textarea field string.

Uses	Description
_sanitize_text_fields()`wp-includes/formatting.php`	Internal helper function to sanitize a string from user input or from the database.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Used by	Description
rest_sanitize_value_from_schema()`wp-includes/rest-api.php`	Sanitize a value based on a schema.

Changelog

Version	Description
4.7.0	Introduced.

云策 WordPress 开发者社区

函数文档