<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"

"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--

#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }

#msg dt { float: left; width: 6em; font-weight: bold; }

#msg dt:after { content:':';}

#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }

#msg dl a { font-weight: bold}

#msg dl a:link    { color:#fc3; }

#msg dl a:active  { color:#ff0; }

#msg dl a:visited { color:#cc6; }

h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }

#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }

#msg ul, pre { overflow: auto; }

#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }

#patch { width: 100%; }

#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}

#patch .propset h4, #patch .binary h4 {margin:0;}

#patch pre {padding:0;line-height:1.2em;margin:0;}

#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}

#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}

#patch span {display:block;padding:0 10px;}

#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}

#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}

#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}

#patch .lines, .info {color:#888;background:#fff;}

--></style>

<title>[13108] trunk/wp-includes/formatting.php:

  Fix typos in inline docs for clean_url() and esc_url().</title>

</head>

<body>

<div id="msg">

<dl>

<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/13108">13108</a></dd>

<dt>Author</dt> <dd>nacin</dd>

<dt>Date</dt> <dd>2010-02-13 10:58:01 +0000 (Sat, 13 Feb 2010)</dd>

</dl>

<h3>Log Message</h3>

<pre>Fix typos in inline docs for clean_url() and esc_url().</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunkwpincludesformattingphp">trunk/wp-includes/formatting.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunkwpincludesformattingphp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/formatting.php (13107 => 13108)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/formatting.php        2010-02-13 10:46:38 UTC (rev 13107)

+++ trunk/wp-includes/formatting.php        2010-02-13 10:58:01 UTC (rev 13108)

</span><span class="lines">@@ -2138,7 +2138,7 @@

<span class="cx">  * Checks and cleans a URL.

</span><span class="cx">  *

</span><span class="cx">  * A number of characters are removed from the URL. If the URL is for displaying

</span><del>- * (the default behaviour) amperstands are also replaced. The 'esc_url' filter

</del><ins>+ * (the default behaviour) amperstands are also replaced. The 'clean_url' filter

</ins><span class="cx">  * is applied to the returned cleaned URL.

</span><span class="cx">  *

</span><span class="cx">  * @since 1.2.0

</span><span class="lines">@@ -2149,7 +2149,7 @@

<span class="cx">  * @param array $protocols Optional. An array of acceptable protocols.

<span class="cx">  *                Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet' if not set.

<span class="cx">  * @param string $context Optional. How the URL will be used. Default is 'display'.

<del>- * @return string The cleaned $url after the 'cleaned_url' filter is applied.

</del><ins>+ * @return string The cleaned $url after the 'clean_url' filter is applied.

</ins><span class="cx">  */

</span><span class="cx"> function clean_url( $url, $protocols = null, $context = 'display' ) {

</span><span class="cx">         $original_url = $url;

</span><span class="lines">@@ -2228,18 +2228,18 @@

<span class="cx">  * Checks and cleans a URL.

</span><span class="cx">  *

</span><span class="cx">  * A number of characters are removed from the URL. If the URL is for displaying

</span><del>- * (the default behaviour) amperstands are also replaced. The 'esc_url' filter

</del><ins>+ * (the default behaviour) amperstands are also replaced. The 'clean_url' filter

</ins><span class="cx">  * is applied to the returned cleaned URL.

</span><span class="cx">  *

</span><span class="cx">  * @since 2.8.0

</span><del>- * @uses esc_url()

</del><ins>+ * @uses clean_url()

</ins><span class="cx">  * @uses wp_kses_bad_protocol() To only permit protocols in the URL set

<span class="cx">  *                via $protocols or the common ones set in the function.

</span><span class="cx">  *

<span class="cx">  * @param string $url The URL to be cleaned.

<span class="cx">  * @param array $protocols Optional. An array of acceptable protocols.

<span class="cx">  *                Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet' if not set.

<del>- * @return string The cleaned $url after the 'cleaned_url' filter is applied.

</del><ins>+ * @return string The cleaned $url after the 'clean_url' filter is applied.

</ins><span class="cx">  */

</span><span class="cx"> function esc_url( $url, $protocols = null ) {

</span><span class="cx">         return clean_url( $url, $protocols, 'display' );

</span><span class="lines">@@ -2248,10 +2248,8 @@

</span><span class="cx"> /**

<span class="cx">  * Performs esc_url() for database usage.

</span><span class="cx">  *

</span><del>- * @see esc_url()

- * @see esc_url()

- *

</del><span class="cx">  * @since 2.8.0

</span><ins>+ * @uses clean_url()

</ins><span class="cx">  *

<span class="cx">  * @param string $url The URL to be cleaned.

<span class="cx">  * @param array $protocols An array of acceptable protocols.

</span></span></pre>

</div>

</div>

</body>

</html>