sanitize_key()WP 3.0.0

Sanitizes a string key.

Keys are used as internal identifiers. Lowercase alphanumeric characters, dashes, and underscores are allowed.

1 time — 0.000013 sec (very fast) | 50000 times — 0.04 sec (speed of light)
Hooks from the function

Return

String. Sanitized key.

Usage

sanitize_key( $key );
$key(string) (required)
String key.

Examples

0

#1 Demo of cleaning

In code below is show how sanitize_key() clears string with uppercase & lowercase letters, numbers, dash, underscore, forward slash, brackets, spaces.

echo sanitize_key( 'Testexample1-_/[]{}' ); // testexample1-_
echo sanitize_key( 'My Key' ); // mykey
echo sanitize_key( 'My-Key' ); // my-key
echo sanitize_key( 'My_Key' ); // my_key

So as you can see this function turn uppercase letter into lowercase, remove forward slash, spaces, brackets and any other non-standard characters.

Changelog

Since 3.0.0 Introduced.

Code of sanitize_key() WP 6.0

function sanitize_key( $key ) {
	$sanitized_key = '';

	if ( is_scalar( $key ) ) {
		$sanitized_key = strtolower( $key );
		$sanitized_key = preg_replace( '/[^a-z0-9_\-]/', '', $sanitized_key );
	}

	/**
	 * Filters a sanitized key string.
	 *
	 * @since 3.0.0
	 *
	 * @param string $sanitized_key Sanitized key.
	 * @param string $key           The key prior to sanitization.
	 */
	return apply_filters( 'sanitize_key', $sanitized_key, $key );
}