clean_url( string $url, array $protocols = null, string $context = 'display' )

This function has been deprecated. Use esc_url() instead.

Checks and cleans a URL.

Description

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.

See also

Parameters

$url

(string) (Required) The URL to be cleaned.

$protocols

(array) (Optional) An array of acceptable protocols.

Default value: null

$context

(string) (Optional) How the URL will be used. Default is 'display'.

Default value: 'display'

Return

(string) The cleaned $url after the 'clean_url' filter is applied.

Source

File: wp-includes/deprecated.php 

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

Uses

Uses Description
wp-includes/formatting.php: esc_url()

Checks and cleans a URL.
wp-includes/functions.php: _deprecated_function()

Mark a function as deprecated and inform when it has been used.

Changelog

Version Description
3.0.0 Use esc_url()
1.2.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/clean_url