Checks and cleans a URL.

Description

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

See also

• esc_url()

Parameters

$urlstringrequired

The URL to be cleaned.

$protocolsarrayoptional

An array of acceptable protocols.

Default:null

$contextstringoptional

How the URL will be used. Default is 'display'.

Default:'display'

Return

Source

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

View all references View on Trac View on GitHub

Changelog