Sanitizes a string from user input or from the database.

Description

• Checks for invalid UTF-8,
• Converts single < characters to entities
• Strips all tags
• Removes line breaks, tabs, and extra whitespace
• Strips percent-encoded characters

See also

• sanitize_textarea_field()
• wp_check_invalid_utf8()
• wp_strip_all_tags()

Parameters

$strstringrequired

String to sanitize.

Return

More Information

Basic Usage

<?php sanitize_text_field( $str ) ?>

Source

function sanitize_text_field( $str ) {
	$filtered = _sanitize_text_fields( $str, false );

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

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘sanitize_text_field’, string $filtered, string $str )

Filters a sanitized text field string.

Changelog