Функция esc_attr__() в WordPress: описание и примеры

Функция esc_attr__() в WordPress используется для перевода и экранирования строк, которые будут использоваться в HTML-атрибутах. Это необходимо для обеспечения безопасности и предотвращения атак XSS (межсайтового скриптинга), а также для правильного отображения переведенных строк в атрибутах HTML.

Описание функции

esc_attr__() принимает два параметра:

1. $text (string): Строка, подлежащая переводу.
2. $domain (string): Текстовый домен.

esc_attr__( string $text, string $domain )

Функция возвращает переведенную и экранированную строку.

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

Рассмотрим несколько примеров использования функции esc_attr__() в WordPress.

Пример 1: Использование в HTML-атрибутах

Предположим, у нас есть форма с полем ввода, и мы хотим перевести и экранировать значение атрибута placeholder.

// Перевод строки для placeholder
$placeholder_text = esc_attr__( 'Enter your name', 'my-plugin-domain' );

// Использование переведенной строки в HTML-атрибуте
echo '<input type="text" placeholder="' . $placeholder_text . '" />';

Пример 2: Использование в атрибутах кнопки

Если у вас есть кнопка с атрибутом title, вы можете использовать esc_attr__() для перевода и экранирования значения этого атрибута.

// Перевод строки для title
$title_text = esc_attr__( 'Click to submit', 'my-plugin-domain' );

// Использование переведенной строки в HTML-атрибуте
echo '<button title="' . $title_text . '">Submit</button>';

Пример 3: Перевод строк для атрибутов в административной панели

Если у вас есть административная панель, где используются атрибуты с переведенными значениями, вы можете использовать esc_attr__() для обеспечения безопасности и правильного отображения.

// Перевод строки для значения атрибута value
$value_text = esc_attr__( 'Save changes', 'my-plugin-domain' );

// Использование переведенной строки в HTML-атрибуте
echo '<input type="submit" value="' . $value_text . '" />';

Пример 4: Использование в JavaScript-коде

Если вам нужно передать переведенные строки в JavaScript-код, вы можете использовать esc_attr__() для экранирования значений перед их вставкой в атрибуты HTML.

// Перевод строки для data-атрибута
$data_text = esc_attr__( 'Translated text for JS', 'my-plugin-domain' );

// Использование переведенной строки в HTML-атрибуте
echo '<div id="example" data-text="' . $data_text . '"></div>';

Заключение

Функция esc_attr__() является важным инструментом для разработчиков WordPress, обеспечивая безопасность и правильное отображение переведенных строк в HTML-атрибутах. Она помогает предотвратить атаки XSS и обеспечивает корректную интернационализацию ваших плагинов и тем. Используя esc_attr__() вместе с другими функциями интернационализации, вы можете создать более безопасные и удобные для пользователей продукты на разных языках.