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

Description

Parameters

$urlstring

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

string

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

Uses · 2

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• esc_url()Checks and cleans a URL.

Source

View on Trac ↗View on GitHub ↗

2047function clean_url( $url, $protocols = null, $context = 'display' ) {2048	if ( $context == 'db' )2049		_deprecated_function( 'clean_url( $context = \'db\' )', '3.0.0', 'sanitize_url()' );2050	else2051		_deprecated_function( __FUNCTION__, '3.0.0', 'esc_url()' );2052	return esc_url( $url, $protocols, $context );2053}

History

Introduced in 1.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.