From e70189bba55bad9732c1bcec001ef11ec95a8d2c Mon Sep 17 00:00:00 2001 From: nacin Date: Sat, 13 Feb 2010 10:58:01 +0000 Subject: [PATCH] Fix typos in inline docs for clean_url() and esc_url(). git-svn-id: http://svn.automattic.com/wordpress/trunk@13108 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/formatting.php | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/wp-includes/formatting.php b/wp-includes/formatting.php index 813458f9cf..141cf64a05 100644 --- a/wp-includes/formatting.php +++ b/wp-includes/formatting.php @@ -2138,7 +2138,7 @@ function wp_htmledit_pre($output) { * 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 + * (the default behaviour) amperstands are also replaced. The 'clean_url' filter * is applied to the returned cleaned URL. * * @since 1.2.0 @@ -2149,7 +2149,7 @@ function wp_htmledit_pre($output) { * @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. * @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' ) { $original_url = $url; @@ -2228,18 +2228,18 @@ function esc_sql( $sql ) { * 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 + * (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. * * @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. + * @return string The cleaned $url after the 'clean_url' filter is applied. */ function esc_url( $url, $protocols = null ) { return clean_url( $url, $protocols, 'display' ); @@ -2248,10 +2248,8 @@ function esc_url( $url, $protocols = null ) { /** * 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. * @param array $protocols An array of acceptable protocols.