Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!Function Reference/sanitize text field
Contents
Description
Sanitize a string from user input or from the db.
Checks for invalid UTF-8, Convert single < characters to entity, strip all tags, remove line breaks, tabs and extra white space, strip octets.
Usage
<?php sanitize_text_field( $str ) ?>
Parameters
- $str
- (string) (required) String to be sanitized.
- Default: None
Return Values
- (string)
- Sanitized string.
Change Log
- Since: 2.9.0
Source File
sanitize_text_field() is located in wp-includes/formatting.php
Related
Functions
sanitize_text_field() is in a class of functions that help you sanitize potentially unsafe data which allow you to pass an arbitrary variable and receive the clean version based on data type. Others include:
- sanitize_email()
- sanitize_file_name()
- sanitize_html_class()
- sanitize_key()
- sanitize_meta()
- sanitize_mime_type()
- sanitize_option()
- sanitize_sql_orderby()
- sanitize_post_field()
- sanitize_text_field()
- sanitize_title()
- sanitize_title_for_query()
- sanitize_title_with_dashes()
- sanitize_user()
Filters
- sanitize_email
- sanitize_file_name
- sanitize_file_name_chars
- sanitize_html_class
- sanitize_key
- sanitize_mime_type
- sanitize_option_$option
- sanitize_text_field
- sanitize_title
- sanitize_trackback_urls
- sanitize_user
See also index of Function Reference and index of Template Tags.
