sanitize_key() │ WP 3.0.0

Очищает строку, чтобы использовать её как ключ. Ключи используются как разные внутренние ID.

Переводит строку в нижний регистр (см. strtolower()) и удаляет из строки все кроме a-z0-9_-.

1 раз — 0.000013 сек (очень быстро) | 50000 раз — 0.04 сек (скорость света)

Хуки из функции

sanitize_key

Возвращает

Строку. Очищенный ключ.

Использование

sanitize_key( $key );

$key(строка) (обязательный): Строка, которая будет использоваться как ключ.

Примеры

#1 Демонстрация очистки ключа

В приведенном ниже коде показано, как sanitize_key() очищает строку с прописными и строчными буквами, цифрами, тире, подчеркиванием, прямой косой чертой, скобками, пробелами.

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

Как видите, эта функция превращает заглавную букву в строчную, удаляет прямую косую черту, пробелы, скобки и любые другие нестандартные символы.

Список изменений

С версии 3.0.0

Введена.

Код `sanitize_key() sanitize key` ^{WP 6.6.2}

wp-includes/formatting.php

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