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

Timestamp:

03/16/2010 07:19:32 PM (15 years ago)

Author:

ryan

Message:

Introduce sanitize_key().

File:

• trunk/wp-includes/formatting.php (modified) (1 diff)

trunk/wp-includes/formatting.php

@@ -749 +749 @@
 
     return apply_filters('sanitize_user', $username, $raw_username, $strict);
+}
+
+/**
+ * Sanitize a string key.
+ *
+ * Keys are used as internal identifiers. They should be lowercase ASCII.  Dashes and underscores are allowed.
+ *
+ * @since 3.0.0
+ * 
+ * @param string $key String key
+ * @return string Sanitized key
+ */
+function sanitize_key( $key ) {
+    $raw_key = $key;
+    $key = wp_strip_all_tags($key);
+    // Kill octets
+    $key = preg_replace('|%([a-fA-F0-9][a-fA-F0-9])|', '', $key);
+    $key = preg_replace('/&.+?;/', '', $key); // Kill entities
+
+    $key = preg_replace('|[^a-z0-9 _.\-@]|i', '', $key);
+
+    // Consolidate contiguous whitespace
+    $key = preg_replace('|\s+|', ' ', $key);
+
+    return apply_filters('sanitize_key', $key, $raw_key);
 }