Warning: This function has been deprecated. Use Alias() instead.

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

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.


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'


Top ↑

Return #

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


Top ↑

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', 'esc_url_raw()' );
	else
		_deprecated_function( __FUNCTION__, '3.0', 'esc_url()' );
	return esc_url( $url, $protocols, $context );
}


Top ↑

Changelog #

Changelog
Version Description
1.2.0 Introduced.


Top ↑

User Contributed Notes #

You must log in before being able to contribute a note.