<!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>[15948] trunk/wp-includes/formatting.php: Idempotence for sanitize_user().</title>
</head>
<body>

<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/15948">15948</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2010-10-24 20:33:54 +0000 (Sun, 24 Oct 2010)</dd>
</dl>

<h3>Log Message</h3>
<pre>Idempotence for sanitize_user().  Make sanitize_key() match its phpdoc. Props duck_ fixes <a href="http://trac.wordpress.org/ticket/15198">#15198</a></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 (15947 => 15948)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/formatting.php        2010-10-24 19:22:39 UTC (rev 15947)
+++ trunk/wp-includes/formatting.php        2010-10-24 20:33:54 UTC (rev 15948)
</span><span class="lines">@@ -724,12 +724,10 @@
</span><span class="cx"> /**
</span><span class="cx">  * Sanitize username stripping out unsafe characters.
</span><span class="cx">  *
</span><del>- * If $strict is true, only alphanumeric characters (as well as _, space, ., -,
- * @) are returned.
- * Removes tags, octets, entities, and if strict is enabled, will remove all
- * non-ASCII characters. After sanitizing, it passes the username, raw username
- * (the username in the parameter), and the strict parameter as parameters for
- * the filter.
</del><ins>+ * Removes tags, octets, entities, and if strict is enabled, will only keep
+ * alphanumeric, _, space, ., -, @. After sanitizing, it passes the username, 
+ * raw username (the username in the parameter), and the value of $strict as
+ * parameters for the 'sanitize_user' filter.
</ins><span class="cx">  *
</span><span class="cx">  * @since 2.0.0
</span><span class="cx">  * @uses apply_filters() Calls 'sanitize_user' hook on username, raw username,
</span><span class="lines">@@ -751,6 +749,7 @@
</span><span class="cx">         if ( $strict )
</span><span class="cx">                 $username = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $username );
</span><span class="cx"> 
</span><ins>+        $username = trim( $username );
</ins><span class="cx">         // Consolidate contiguous whitespace
</span><span class="cx">         $username = preg_replace( '|\s+|', ' ', $username );
</span><span class="cx"> 
</span><span class="lines">@@ -760,7 +759,7 @@
</span><span class="cx"> /**
</span><span class="cx">  * Sanitize a string key.
</span><span class="cx">  *
</span><del>- * Keys are used as internal identifiers. They should be lowercase ASCII.  Dashes and underscores are allowed.
</del><ins>+ * Keys are used as internal identifiers. Lowercase alphanumeric characters, dashes and underscores are allowed.
</ins><span class="cx">  *
</span><span class="cx">  * @since 3.0.0
</span><span class="cx">  *
</span><span class="lines">@@ -769,13 +768,9 @@
</span><span class="cx">  */
</span><span class="cx"> function sanitize_key( $key ) {
</span><span class="cx">         $raw_key = $key;
</span><del>-
-        $key = preg_replace('|[^a-z0-9 _.\-@]|i', '', $key);
-
-        // Consolidate contiguous whitespace
-        $key = preg_replace('|\s+|', ' ', $key);
-
-        return apply_filters('sanitize_key', $key, $raw_key);
</del><ins>+        $key = strtolower( $key );
+        $key = preg_replace( '/[^a-z0-9_\-]/', '', $key );
+        return apply_filters( 'sanitize_key', $key, $raw_key );
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> /**
</span></span></pre>
</div>
</div>

</body>
</html>