Changeset 13108

Timestamp:

02/13/2010 10:58:01 AM (15 years ago)

Author:

nacin

Message:

Fix typos in inline docs for clean_url() and esc_url().

File:

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

trunk/wp-includes/formatting.php

@@ -2139 +2139 @@
  *
  * 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
+ * (the default behaviour) amperstands are also replaced. The 'clean_url' filter
  * is applied to the returned cleaned URL.
  *
@@ -2150 +2150 @@
  *      Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet' if not set.
  * @param string $context Optional. How the URL will be used. Default is 'display'.
- * @return string The cleaned $url after the 'cleaned_url' filter is applied.
+ * @return string The cleaned $url after the 'clean_url' filter is applied.
  */
 function clean_url( $url, $protocols = null, $context = 'display' ) {
@@ -2229 +2229 @@
  *
  * 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
+ * (the default behaviour) amperstands are also replaced. The 'clean_url' filter
  * is applied to the returned cleaned URL.
  *
  * @since 2.8.0
- * @uses esc_url()
+ * @uses clean_url()
  * @uses wp_kses_bad_protocol() To only permit protocols in the URL set
  *      via $protocols or the common ones set in the function.
@@ -2240 +2240 @@
  * @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.
+ * @return string The cleaned $url after the 'clean_url' filter is applied.
  */
 function esc_url( $url, $protocols = null ) {
@@ -2249 +2249 @@
  * Performs esc_url() for database usage.
  *
- * @see esc_url()
- * @see esc_url()
- *
  * @since 2.8.0
+ * @uses clean_url()
  *
  * @param string $url The URL to be cleaned.