sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Add a note that the $protocols parameter of esc_url_raw() defaults to return value of wp_allowed_protocols().

Browse Source 
This complements already existing note in `esc_url()`.

Props audrasjb.
Fixes #50147.

git-svn-id: https://develop.svn.wordpress.org/trunk@47783 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-05-11 20:32:06 +00:00
parent 892e013bbf
commit eae306d5bf
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/wp-includes/formatting.php
View File

@ -4300,9 +4300,9 @@ function esc_sql( $data ) {
* *
* @param string $url The URL to be cleaned. * @param string $url The URL to be cleaned.
* @param string[] $protocols Optional. An array of acceptable protocols. * @param string[] $protocols Optional. An array of acceptable protocols.
* Defaults to return value of wp_allowed_protocols() * Defaults to return value of wp_allowed_protocols().
* @param string $_context Private. Use esc_url_raw() for database usage. * @param string $_context Private. Use esc_url_raw() for database usage.
* @return string The cleaned $url after the {@see 'clean_url'} filter is applied. * @return string The cleaned URL after the {@see 'clean_url'} filter is applied.
*/ */
function esc_url( $url, $protocols = null, $_context = 'display' ) { function esc_url( $url, $protocols = null, $_context = 'display' ) {
$original_url = $url; $original_url = $url;
@ -4408,7 +4408,8 @@ function esc_url( $url, $protocols = null, $_context = 'display' ) {
* @since 2.8.0 * @since 2.8.0
* *
* @param string $url The URL to be cleaned. * @param string $url The URL to be cleaned.
* @param string[] $protocols An array of acceptable protocols. * @param string[] $protocols Optional. An array of acceptable protocols.
* Defaults to return value of wp_allowed_protocols().
* @return string The cleaned URL. * @return string The cleaned URL.
*/ */
function esc_url_raw( $url, $protocols = null ) { function esc_url_raw( $url, $protocols = null ) {