A WordPress-centric search engine for devs and theme authors



clean_url ›

Since1.2.0
Deprecated3.0.0
clean_url ( $url, $protocols = null, $context = 'display' )
Parameters: (3)
  • (string) $url The URL to be cleaned.
    Required: Yes
  • (array) $protocols Optional. An array of acceptable protocols.
    Required: No
    Default: null
  • (string) $context Optional. How the URL will be used. Default is 'display'.
    Required: No
    Default: 'display'
See:
Returns:
  • (string) The cleaned $url after the {@see 'clean_url'} filter is applied.
Defined at:
Codex:

Checks and cleans a URL.

A number of characters are removed from the URL. If the URL is for displaying (the default behaviour) ampersands are also replaced. The 'clean_url' filter is applied to the returned cleaned URL.



Source

function clean_url( $url, $protocols = null, $context = 'display' ) {
	if ( $context == 'db' )
		_deprecated_function( 'clean_url( $context = \'db\' )', '3.0.0', 'esc_url_raw()' );
	else
		_deprecated_function( __FUNCTION__, '3.0.0', 'esc_url()' );
	return esc_url( $url, $protocols, $context );
}