clean_url() │ WP 1.2.0

Checks and cleans a URL.

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 is applied to the returned cleaned URL.

No Hooks.

Returns

String. The cleaned $url after the clean_url filter is applied.

Usage

clean_url( $url, $protocols, $context );

$url(string) (required)

The URL to be cleaned.

$protocols(array)

An array of acceptable protocols.
Default: null

$context(string)

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

Notes

• See: esc_url()

Changelog

clean_url() clean url code ^{WP 6.9.1}

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 );
}