Changeset 11383 for trunk/wp-includes/formatting.php

Timestamp:

05/18/2009 04:00:33 PM (14 years ago)

Author:

markjaquith

Message:

Deprecate sanitize_url() and clean_url() in favor of esc_url_raw() and esc_url()

File:

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

trunk/wp-includes/formatting.php

@@ -1150 +1150 @@
 function _make_url_clickable_cb($matches) {
     $url = $matches[2];
-    $url = clean_url($url);
+    $url = esc_url($url);
     if ( empty($url) )
         return $matches[0];
@@ -1172 +1172 @@
     $dest = $matches[2];
     $dest = 'http://' . $dest;
-    $dest = clean_url($dest);
+    $dest = esc_url($dest);
     if ( empty($dest) )
         return $matches[0];
@@ -1989 +1989 @@
  *
  * A number of characters are removed from the URL. If the URL is for displaying
- * (the default behaviour) amperstands are also replaced. The 'clean_url' filter
+ * (the default behaviour) amperstands are also replaced. The 'esc_url' filter
  * is applied to the returned cleaned URL.
  *
@@ -2033 +2033 @@
 
 /**
- * Performs clean_url() for database usage.
- *
- * @see clean_url()
+ * Checks and cleans a URL.
+ *
+ * A number of characters are removed from the URL. If the URL is for displaying
+ * (the default behaviour) amperstands are also replaced. The 'esc_url' filter
+ * is applied to the returned cleaned URL.
+ *
+ * @since 2.8.0
+ * @uses esc_url()
+ * @uses wp_kses_bad_protocol() To only permit protocols in the URL set
+ *      via $protocols or the common ones set in the function.
+ *
+ * @param string $url The URL to be cleaned.
+ * @param array $protocols Optional. An array of acceptable protocols.
+ *      Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet' if not set.
+ * @return string The cleaned $url after the 'cleaned_url' filter is applied.
+ */
+function esc_url( $url, $protocols = null ) {
+    return clean_url( $url, $protocols, 'display' );
+}
+
+/**
+ * Performs esc_url() for database usage.
+ *
+ * @see esc_url()
+ * @see esc_url()
+ *
+ * @since 2.8.0
+ *
+ * @param string $url The URL to be cleaned.
+ * @param array $protocols An array of acceptable protocols.
+ * @return string The cleaned URL.
+ */
+function esc_url_raw( $url, $protocols = null ) {
+    return clean_url( $url, $protocols, 'db' );
+}
+
+/**
+ * Performs esc_url() for database or redirect usage.
+ *
+ * @see esc_url()
+ * @deprecated 2.8.0
  *
  * @since 2.3.1
@@ -2281 +2319 @@
         case 'home':
             $value = stripslashes($value);
-            $value = clean_url($value);
+            $value = esc_url($value);
             break;
         default :