wp_sanitize_redirect

Sanitizes a URL for use in a redirect.

Description

(string) wp_sanitize_redirect( (string) $location ); 

Returns (string)

Redirect-sanitized URL.

Parameters (1)

0. $location (string)
The path to redirect to.

Usage

  1. if ( !function_exists( 'wp_sanitize_redirect' ) ) { 
  2.     require_once ABSPATH . WPINC . '/pluggable.php'; 
  3. } 
  4.   
  5. // The path to redirect to. 
  6. $location = ''; 
  7.   
  8. // NOTICE! Understand what this does before running. 
  9. $result = wp_sanitize_redirect($location); 
  10.     

Defined (1)

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

/wp-includes/pluggable.php  
  1. function wp_sanitize_redirect($location) { 
  2.     $regex = '/ 
  3.         ( 
  4.             (?: [\xC2-\xDF][\x80-\xBF]        # double-byte sequences   110xxxxx 10xxxxxx 
  5.             |   \xE0[\xA0-\xBF][\x80-\xBF]    # triple-byte sequences   1110xxxx 10xxxxxx * 2 
  6.             |   [\xE1-\xEC][\x80-\xBF]{2} 
  7.             |   \xED[\x80-\x9F][\x80-\xBF] 
  8.             |   [\xEE-\xEF][\x80-\xBF]{2} 
  9.             |   \xF0[\x90-\xBF][\x80-\xBF]{2} # four-byte sequences   11110xxx 10xxxxxx * 3 
  10.             |   [\xF1-\xF3][\x80-\xBF]{3} 
  11.             |   \xF4[\x80-\x8F][\x80-\xBF]{2} 
  12.  ) {1, 40}                              # ...one or more times 
  13.  )/x'; 
  14.     $location = preg_replace_callback( $regex, '_wp_sanitize_utf8_in_redirect', $location ); 
  15.     $location = preg_replace('|[^a-z0-9-~+_.?#=&;, /:%!*\[\]()@]|i', '', $location); 
  16.     $location = wp_kses_no_null($location); 
  17.  
  18.     // remove %0d and %0a from location 
  19.     $strip = array('%0d', '%0a', '%0D', '%0A'); 
  20.     return _deep_replace( $strip, $location ); 
  21. }