Функция sanitize_url() в WordPress с примерами

Доступна с версии: 2.3.1

Функция sanitize_url() используется для очистки и фильтрации URL-адресов перед их использованием, например, для редиректов или хранения в базе данных. Она защищает от некорректных и потенциально опасных данных в URL, а также позволяет указать список допустимых протоколов.

sanitize_url( string $url, string[] $protocols = null ): string

Параметры

$url (string) (обязательный):
URL, который нужно очистить. Это может быть URL, введенный пользователем, полученный из запроса или из других источников.
$protocols (string[]) (опциональный):
Массив протоколов, которые считаются допустимыми (например, http, https, ftp). По умолчанию используется возвращаемое значение функции wp_allowed_protocols(), которое включает такие протоколы как http, https, ftp, и другие.

Возвращаемое значение

string: Очищенный URL, который прошел обработку через функцию esc_url() с контекстом db (для безопасного использования в базе данных).

Описание

Функция sanitize_url() проверяет и очищает URL, удаляя небезопасные или некорректные элементы. Внутри она использует функцию esc_url(), которая также удаляет потенциально опасные символы и проверяет корректность протоколов. Эта функция полезна при работе с пользовательскими вводами, при редиректах или сохранении URL в базе данных.

Важные моменты:

Если URL не содержит допустимого протокола, функция вернет пустую строку.
Функция может фильтровать URL по заданным протоколам. Если передать только http и https, все остальные протоколы будут отклонены.

Пример 1: Очистка URL перед использованием в заголовке

Этот пример иллюстрирует очистку URL перед добавлением в заголовок HTTP-запроса:

// Получаем URL REST API
$url = get_rest_url();

// Используем sanitize_url() для очистки URL перед вставкой в заголовок
header( sprintf( 'Link: <%s>; rel="https://api.w.org/"', sanitize_url( $url ) ), false );

Пример 2: Фильтрация только по протоколам `http` и `https`

Функция sanitize_url() позволяет ограничивать URL только разрешенными протоколами:

// Ссылка на ftp-ресурс
$url = 'ftp://ftp.example.com/pub/file.zip';
$new_url = sanitize_url( $url, array( 'http', 'https' ) );
// Вернёт пустую строку, так как протокол ftp не разрешён

// Обычная ссылка на HTTPS сайт
$url = 'https://example.com/projects/';
$new_url = sanitize_url( $url, array( 'http', 'https' ) );
// Вернёт: 'https://example.com/projects/'

Пример 3: Очистка пользовательского URL перед сохранением в базе данных

Если пользователь ввел URL, его можно очистить перед сохранением:

$user = new stdClass();

if ( isset( $_POST['url'] ) ) {
    // Очистка введенного URL
    $user->user_url = sanitize_url( $_POST['url'] );
}

// Сохраняем данные пользователя
$user_id = wp_insert_user( $user );

Пример 4: Очистка различных URL

var_dump( sanitize_url( 'https://example.com/foo' ) ); // 'https://example.com/foo'
var_dump( sanitize_url( 'https://example.com/foo-%2F-M' ) ); // 'https://example.com/foo-%2F-M'
var_dump( sanitize_url( '/foo' ) ); // '/foo'
var_dump( sanitize_url( '' ) ); // string(0) ""
var_dump( sanitize_url( false ) ); // string(0) ""
var_dump( sanitize_url( null ) ); // string(0) ""
var_dump( sanitize_url( true ) ); // 'http://1'

Важные функции, связанные с sanitize_url()

esc_url(): Основная функция, которая очищает URL для безопасного использования.
wp_allowed_protocols(): Возвращает массив разрешённых протоколов, используемый по умолчанию для проверки URL.

Заключение

Функция sanitize_url() обеспечивает безопасное использование URL-адресов в WordPress. Она может быть полезна для очистки данных, введенных пользователями, и защиты от потенциальных уязвимостей. Возможность указать конкретные протоколы для фильтрации делает её ещё более гибкой в работе с различными типами URL.

Стартовая премиум тема для WordPress

Демо импорт тестового контента в 1 клик.

SEO оптимизированный и валидный код.

Множество готовых стартовых сайтов.

Лучшая документация и поддержка.

Опции персонализации контента.

Креативный и современный дизайн.

Тема для WordPress

Функция sanitize_url() в WordPress с примерами

Пример 1: Очистка URL перед использованием в заголовке

Пример 2: Фильтрация только по протоколам http и https

Пример 3: Очистка пользовательского URL перед сохранением в базе данных

Пример 4: Очистка различных URL

Заключение

Стартовая премиум тема для WordPress

Дополнительно по: Безопасность

apache_mod_loaded()

dbDelta()

get_meta_sql()

get_num_queries()

get_posts_by_author_sql()

sanitize_sql_orderby()

esc_sql()

esc_textarea()

esc_url_raw()

sanitize_email()

sanitize_file_name()

sanitize_html_class()

sanitize_option()

sanitize_post_field()

sanitize_text_field()

sanitize_textarea_field()

clean_attachment_cache()

clean_term_cache()

wp_using_ext_object_cache()

wp_suspend_cache_invalidation()

wp_suspend_cache_addition()

wp_defer_term_counting()

wp_clean_update_cache()

wp_cache_set()

wp_cache_replace()

wp_cache_incr()

wp_cache_get_last_changed()

wp_cache_get()

wp_cache_flush_runtime()

wp_cache_flush()

wp_cache_delete()

wp_cache_decr()

wp_cache_add_non_persistent_groups()

wp_cache_add_global_groups()

wp_cache_add()

clean_post_cache()

clean_comment_cache()

_prime_post_caches()

delete_expired_transients()

delete_transient()

set_transient()

get_transient()

_doing_it_wrong()

cache_javascript_headers()

do_robots()

nocache_headers()

show_admin_bar()

wp_check_browser_version()

wp_get_referer()

wp_install_defaults()

wp_redirect()

wp_validate_redirect()

wp_validate_boolean()

wp_get_environment_type()

get_home_path()

esc_url()

esc_html()

esc_attr()

esc_js()

force_ssl_admin()

wp_check_password()

auth_redirect()

wp_logout()

wp_safe_redirect()

wp_die()

wp_authenticate()

current_user_can()

check_admin_referer()

check_ajax_referer()

sanitize_url()

wp_create_nonce()

wp_generate_password()

Пример 2: Фильтрация только по протоколам `http` и `https`