wpseek.com
A WordPress-centric search engine for devs and theme authors



sanitize_key › WordPress Function

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.


Related Functions: sanitize_meta, sanitize_term, sanitize_user, sanitize_title, sanitize_email

Source 

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 );
}