sanitize_text_field

Filters a sanitized text field string.

Description

apply_filters( 'sanitize_text_field', (string) $filtered, (string) $str ); 

Parameters (2)

0. $filtered (string)
The sanitized string.
1. $str (string)
The string prior to being sanitized.

Usage

To run the hook, copy the example below.
  1. $filtered = apply_filters( 'sanitize_text_field', $filtered, $str ); 
  2.  
  3. if ( !empty( $filtered ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the sanitize_text_field callback 
  2. function filter_sanitize_text_field( $filtered, $str ) { 
  3. // make filter magic happen here... 
  4. return $filtered
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'sanitize_text_field', 'filter_sanitize_text_field', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'sanitize_text_field', 'filter_sanitize_text_field', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/formatting.php  
  1. return apply_filters( 'sanitize_text_field', $filtered, $str );