Документация WordPress

sanitize_title

Функция sanitize_title() в WordPress используется для создания «чистого» и безопасного URL-совместимого заголовка (slug) из заданного текста. Она удаляет или заменяет любые символы, которые не подходят для использования в URL, и приводит строку к нижнему регистру. Эта функция часто применяется для создания слагов из названий постов, страниц, категорий и других таксономий.

sanitize_title( $title, $fallback_title = '', $context = 'save' );

$title (строка, обязательный): Заголовок, который нужно очистить.
$fallback_title (строка, необязательный): Значение по умолчанию, которое будет возвращено, если после очистки заголовок окажется пустым. По умолчанию — пустая строка.
$context (строка, необязательный): Контекст использования. Возможные значения: save, db, display, edit, и query. По умолчанию — save.

Пример использования

Создание слага из заголовка поста:

В этом примере из строки 'Пример заголовка для поста!' создается URL-совместимый слаг 'primer-zagolovka-dlya-posta'.

Использование резервного значения:

Если исходный заголовок пустой, функция вернет значение из переменной $fallback, в данном случае 'default-title'.

Подробное объяснение

$title: Основной параметр, содержащий текст, который нужно очистить. Эта строка будет преобразована в формат, пригодный для использования в URL.
$fallback_title: Резервный заголовок используется, если после очистки строка окажется пустой. Это полезно, чтобы избежать пустых слагов.
$context: Контекст определяет, как будет обрабатываться строка. В большинстве случаев используется контекст save, который оптимален для создания слагов при сохранении данных.

Что делает функция

Функция sanitize_title выполняет следующие действия:

Приводит строку к нижнему регистру.
Удаляет нежелательные символы (например, знаки препинания, специальные символы и т. д.).
Заменяет пробелы и другие разделители на дефисы (-).
Преобразует кириллические и другие символы в латиницу (транслитерация).

Применение в WordPress

Функция sanitize_title используется в WordPress повсеместно, например:

При создании слага для URL поста или страницы.
При генерации слага для категории, тега или другой таксономии.
В плагинах и темах, когда нужно создать URL-совместимое имя на основе произвольного текста.

Функция sanitize_title является важной частью системы WordPress, которая помогает обеспечить корректное формирование URL на основе пользовательского ввода. Она широко используется для создания слагов, обеспечивая их совместимость с форматами URL и предотвращая проблемы с отображением и доступностью.

theme