A WordPress-centric search engine for devs and theme authors



sanitize_key ›

Since3.0.0
Deprecatedn/a
sanitize_key ( $key )
Parameters:
  • (string) $key String key
    Required: Yes
Returns:
  • (string) Sanitized key
Defined at:
Codex:

Sanitizes a string key.

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



Source

function sanitize_key( $key ) {
	$raw_key = $key;
	$key     = strtolower( $key );
	$key     = preg_replace( '/[^a-z0-9_\-]/', '', $key );

	/**
	 * Filters a sanitized key string.
	 *
	 * @since 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 );
}