sanitize_key( string $key )
Sanitizes a string key.
Description
Keys are used as internal identifiers. Lowercase alphanumeric characters, dashes, and underscores are allowed.
Parameters
- $key
-
(Required) String key.
Return
(string) Sanitized key.
Source
File: wp-includes/formatting.php
function sanitize_key( $key ) {
$raw_key = $key;
$key = strtolower( $key );
$key = preg_replace( '/[^a-z0-9_\-]/', '', $key );
/**
* Filters a sanitized key string.
*
* @since WP-3.0.0
*
* @param string $key Sanitized key.
* @param string $raw_key The key prior to sanitization.
*/
return apply_filters( 'sanitize_key', $key, $raw_key );
}
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |