load_plugin_textdomain() — это функция в WordPress, которая загружает файл перевода для плагина, обеспечивая его локализацию и перевод на различные языки. Эта функция помогает разработчикам создавать многоязычные плагины, которые могут отображать текст на языке, выбранном пользователем.
load_plugin_textdomain( $domain, $deprecated, $plugin_rel_path )- $domain (string): Текстовый домен, который будет использоваться для перевода строк в плагине.
- $deprecated (string): Устаревший параметр, который не используется.
- $plugin_rel_path (string, необязательный): Путь к каталогу с файлами перевода относительно корневого каталога плагина.
Зачем использовать load_plugin_textdomain()?
- Локализация: Обеспечивает возможность перевода строк в плагине на разные языки.
- Удобство: Позволяет легко управлять файлами перевода и загружать их при инициализации плагина.
- Интернационализация: Помогает разработчикам создавать плагины, пригодные для использования в разных языковых средах.
Пример использования
Наиболее распространенный способ использования load_plugin_textdomain() — вызов функции в основном файле плагина для загрузки файлов перевода из папки languages в корневом каталоге плагина.
function my_plugin_load_textdomain() {
load_plugin_textdomain( 'my-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
}
add_action( 'plugins_loaded', 'my_plugin_load_textdomain' );В этом примере:
my-plugin— текстовый домен плагина.false— устаревший параметр.dirname( plugin_basename( __FILE__ ) ) . '/languages'— путь к каталогу с файлами перевода.
Создание файлов перевода
Чтобы строки в вашем плагине можно было перевести, нужно создать файлы перевода (например, .po и .mo файлы) для вашего текстового домена. Эти файлы обычно создаются с помощью специальных инструментов, таких как Poedit.
Шаги для создания файлов перевода
- Создайте PO-файл: Используйте инструмент, такой как Poedit, для создания файла перевода.
- Заполните переводы: Введите переводы для всех строк, использующих текстовый домен вашего плагина.
- Сохраните MO-файл: Poedit автоматически сгенерирует MO-файл, который будет использоваться WordPress для перевода.
Заключение
Функция load_plugin_textdomain() является важным инструментом для разработчиков WordPress, обеспечивая возможность локализации и перевода плагинов. Использование этой функции помогает создать многоязычные плагины, которые могут отображать текст на языке пользователя, улучшая удобство и доступность.