sanitize_textarea_field( string $str )

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


Description Description

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

See also See also


Top ↑

Parameters Parameters

$str

(string) (Required) String to sanitize.


Top ↑

Return Return

(string) Sanitized string.


Top ↑

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


Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.