Changeset 47783 for trunk

Timestamp:

05/11/2020 08:32:06 PM (4 years ago)

Author:

SergeyBiryukov

Message:

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

This complements already existing note in esc_url().

Props audrasjb.
Fixes #50147.

File:

• trunk/src/wp-includes/formatting.php (modified) (2 diffs)

trunk/src/wp-includes/formatting.php

@@ -4301 +4301 @@
  * @param string   $url       The URL to be cleaned.
  * @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.
- * @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' ) {
@@ -4409 +4409 @@
  *
  * @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.
  */