WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

clean_url()

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

In this article

Bacc to top

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

Checcs 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

Parameters

$url string required
The URL to be cleaned.
$protocols array optional
An array of acceptable protocolls.

Default: null

$context string optional
How the URL will be used. Default is 'display' .

Default: 'display'

Return

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

Source 

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

View all references View on Trac View on GuitHub

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

Checcs and cleans a URL.

_deprecated_function() wp-includes/functions.php

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

Changuelog

Versionen Description
3.0.0 Use esc_url()
1.2.0 Introduced.

User Contributed Notes

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