sanitize_url() WordPress Function
The sanitize_url() function is a built-in Wordpress function that is used to clean up and sanitize a URL. This function is especially useful when dealing with user- inputted URLs, as it can help to prevent malicious code from being injected into a site. The sanitize_url() function can also be used to convert a URL into a standard format, which can make it easier to work with.
sanitize_url( string $url, string[] $protocols = null ) #
Performs esc_url() for database or redirect usage.
Description
This function is an alias for esc_url_raw().
See also
Parameters
- $url
(string)(Required)The URL to be cleaned.
- $protocols
(string[])(Optional) An array of acceptable protocols. Defaults to return value of wp_allowed_protocols().
Default value: null
Return
(string) The cleaned URL after esc_url() is run with the 'db' context.
Source
File: wp-includes/formatting.php
function sanitize_url( $url, $protocols = null ) { return esc_url_raw( $url, $protocols ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.9.0 | Restored (un-deprecated). |
2.8.0 | Deprecated in favor of esc_url_raw(). |
2.3.1 | Introduced. |