W3cubDocs

/WordPress

sanitize_textarea_field( string $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

$str: (string) (Required) String to sanitize.

Return

(string) Sanitized string.

Source

File: wp-includes/formatting.php

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

Uses

Uses	Description
wp-includes/formatting.php: _sanitize_text_fields()	Internal helper function to sanitize a string from user input or from the db
wp-includes/formatting.php: sanitize_textarea_field	Filters a sanitized textarea field string.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.

Changelog

Version	Description
4.7.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/sanitize_textarea_field