sanitize_url( string $url, string[] $protocols = null ): string

Parameters

$urlstring

The URL to be cleaned.

$protocolsstring[]optional

An array of acceptable protocols. Defaults to return value of wp_allowed_protocols().Default: null

Return

string

The cleaned URL after esc_url() is run with the 'db' context.

Uses · 1

• esc_url()Checks and cleans a URL.

Used by · 50

• Custom_Background::handle_upload()Handles an Image upload for the background image.
• Custom_Background::wp_set_background_image()
• Custom_Image_Header::set_header_image()Chooses a header image, selected from existing uploaded and default headers, or provides an array of uploaded header data (either new, or from media library).
• WP_Customize_Manager::_sanitize_background_setting()Callback for validating a background setting value.
• WP_Customize_Manager::_sanitize_external_header_video()Callback for sanitizing the external_header_video value.
• WP_Customize_Manager::_validate_external_header_video()Callback for validating the external_header_video value.
• WP_Customize_Manager::customize_pane_settings()Prints JavaScript settings for parent window.
• WP_Customize_Manager::customize_preview_settings()Prints JavaScript settings for preview frame.
• WP_Customize_Manager::set_preview_url()Sets the initial URL to be previewed.
• WP_Customize_Manager::set_return_url()Sets URL to link the user to when closing the Customizer.
• WP_Customize_Nav_Menu_Item_Setting::sanitize()Sanitize an input.
• WP_REST_Font_Faces_Controller::sanitize_src()Sanitizes a single src value for a font face.

Source

View on Trac ↗View on GitHub ↗

4618function sanitize_url( $url, $protocols = null ) {4619	return esc_url( $url, $protocols, 'db' );4620}

History

Introduced in 2.3.1. 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.0.4 tag, from src/wp-includes/formatting.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.