Функция переводит строку, а затем экранирует в ней HTML-теги. То есть переведённая строка может быть безопасно использована в теле HTML-документа без риска, что сломается вёрстка или, что хуже, возникнет уязвимость.
Обратите внимание, что даже если по каким-то причинам строку перевести не удастся, она будет проэкранирована в любом случае.
Также рекомендую уроки:
esc_html__( $text, $domain = 'default' )
Параметры
- $text
- (строка) Текст, который требуется перевести.
- $domain
- (строка) Уникальный идентификатор перевода, часто совпадает с названием директории темы/плагина.
Примеры
1. Как работает функция
Итак, как вы уже возможно могли догадаться, функция esc_html__()
является аналогом комбинации функций __() и esc_html(). Вот чекайте:
$text = esc_html__( 'This is text with HTML.', 'truemisha' );
Полностью идентично:
$text = esc_html( __( 'This is text with HTML.', 'truemisha' ) );
2. Базовое использование
<h1><?php echo esc_html__( 'Title', 'truemisha' ) ?></h1>