Функция sanitize_key() │ WP 3.0.0

Функция sanitize_key() используется для очистки строковых ключей.

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

• Вре��я выполнения 1 раз — 0.000013 секунд (очень быстро)
• Время выполнения 50 000 раз — 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 — функция была введена в WordPress.

Код функции sanitize_key()

Функция находится в файле 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 );
}

/**
 * Фильтрует очищенную строку ключа.
 *
 * @since 3.0.0
 *
 * @param string $sanitized_key Очищенный ключ.
 * @param string $key           Ключ до очистки.
 */
return apply_filters( 'sanitize_key', $sanitized_key, $key );

}

Связанные функции

Функции, начинающиеся на sanitize_, выполняют аналогичные задачи по очистке данных. Вот некоторые из них:

• sanitize_email() — очистка адреса электронной почты.
• sanitize_file_name() — очистка имени файла.
• sanitize_html_class() — очистка классов для HTML.
• sanitize_meta() — очистка метаданных.
• sanitize_mime_type() — проверка типа MIME.
• sanitize_option() — очистка опций.
• sanitize_post() — очистка постов.
• sanitize_post_field() — очистка полей постов.
• sanitize_sql_orderby() — очистка порядка SQL.
• sanitize_term() — очистка терминов.
• sanitize_text_field() — очистка текстового поля.
• sanitize_textarea_field() — очистка текстовой области.
• sanitize_title() — очистка заголовка.
• sanitize_title_for_query() — очистка заголовка для запроса.
• sanitize_title_with_dashes() — очистка заголовка с дефисами.
• sanitize_url() — очистка URL.
• sanitize_user() — очистка данных пользователя.
• wc_clean() — очистка данных WooCommerce.
• wp_check_invalid_utf8() — проверка на наличие некорректных символов UTF-8.

Эти функции помогают поддерживать безопасность и целостность данных в WordPress.