Функция ESC_HTML_E() в WordPress
Описание
ESC_HTML_E() — это функция в WordPress, которая переводит заданную строку и очищает её для отображения на экране. Она заменяет специальные символы на HTML-сущности, что позволяет правильно отображать текст в HTML-коде.
Если вам нужно просто получить переведённый текст, не выводя его на экран, используйте функцию esc_html__().
Применение
Сигнатура функции
esc_html_e( $text, $domain );
- $text (string) — обязательный параметр. Текст, который нужно перевести.
- $domain (string) — домен текста. Уникальный идентификатор для получения переведённых строк. По умолчанию равен 'default'.
Возвращаемое значение
Функция ничего не возвращает (null).
Примеры использования
Пример 1
Вывод текста с HTML тегами
HTML.
', 'kama' ) ); ?>
Или альтернативный способ:
echo esc_html__( 'Любой текст с HTML.
', 'kama' );
Пример 2
Вывод в теге <textarea>
Если перевод содержит HTML-теги или символы, которые должны отображаться как есть (например, в теге <textarea>), разумно использовать эту функцию:
Изменения
Функция была введена в WordPress версии 2.8.0.
Код функции
Функция esc_html_e() реализована следующим образом:
function esc_html_e( $text, $domain = 'default' ) {
echo esc_html( translate( $text, $domain ) );
}
Связанные функции
Вот несколько функций, которые могут быть полезны в работе с текстами:
- esc_attr() — очищает атрибуты HTML.
- esc_js() — очищает строку для использования в JavaScript.
- esc_url() — очищает URL.
- translate() — переводит заданный текст.
Подсказка
Используйте esc_html_e() для вывода строк, которые нужно безопасно использовать в HTML. Это поможет избежать проблем с неправильным отображением символов или возможными уязвимостями в вашей теме или плагине WordPress.