WordPress как на ладони
WordPress Meetup #4. Встречаемся в Москве wordpress jino

load_plugin_textdomain() WP 1.5

Загружает строку для перевода плагина из .mo файла. Не работает с MU плагинами.

.mo файл должен называться: $domain-локаль, где локаль это код языка или страны. Например, русская локаль - ru_RU. Например, если $domain = my-plugin, то файлы должны назваться: my-plugin-ru_RU.mo и my-plugin-ru_RU.po.

Вызывать функцию нужно через хук plugins_loaded.

С версии 4.6. функция сначала пытается загрузить .mo файл с папки WP_LANG_DIR/plugins/ обычно это /wp-content/language/plugins.

Для подключения перевода темы, используйте load_theme_textdomain().

Работает на основе: load_textdomain()
Хуки из функции:
Возвращает

true/false. Вернет false, если .mo файл не существует по указанному пути. В остальных случаях функция вернет true.

Использование

load_plugin_textdomain( $domain, $deprecated, $plugin_rel_path );
$domain(строка) (обязательный)
Уникальный идентификатор для получения строки перевода.
По умолчанию: нет
$deprecated(строка)
Отмененный аргумент, работает до версии 2.7. Путь подобный ABSPATH, до .mo файла.
По умолчанию: false
$plugin_rel_path(строка)

Путь до каталога .mo файлов относительно WP_PLUGIN_DIR (с закрывающим слэшем).

Если путь не указан, то им будет корневая директория плагинов WP_PLUGIN_DIR. Т.е. путь до файла будет такой: WP_PLUGIN_DIR/ru_RU.mo

По умолчанию: false

Примеры

#1. Регистрация файла перевода для плагина

add_action('plugins_loaded', 'myplugin_init');
function myplugin_init(){
	load_plugin_textdomain( 'my-plugin', false, dirname( plugin_basename( __FILE__ ) ) ); 
}

Теперь, файл перевода должен лежать в каталоге плагина и должен называться: my-plugin-ru_RU.mo

#1.2 Если мы хотим расположить файл перевода .mo в подпапку languages:

add_action('plugins_loaded', 'myplugin_init');
function myplugin_init() {
	 load_plugin_textdomain( 'my-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
}

#2. Регистрация файла перевода для MU плагина

В WP по умолчанию нет функции, которая будет регистрировать файл перевода для обязательного плагина.

Для этого я написал такую функцию на основе этой load_plugin_textdomain(). Функция сначала проверяет наличие файла перевода в каталоге /wp-content/languages/plugins/... и затем ищет .mo файл в папке плагина. Также применяет нужный хук plugin_locale, его например использует плагин переводов Loco Translate.

/**
 * Загружает строку для перевода MU плагина из .mo файла.
 * На основе https://wp-kama.ru/function/load_plugin_textdomain
 * @param  string $domain                    Уникальный идентификатор для получения строки перевода.
 * @param  string [$plugin_rel_path = false] Путь до каталога .mo файлов относительно WPMU_PLUGIN_DIR (с закрывающим слэшем).
 * @return boolean  true/false
 */
function load_mu_plugin_textdomain( $domain, $plugin_rel_path = false ) {
	/**
	 * Filters a plugin's locale.
	 *
	 * @since 3.0.0
	 *
	 * @param string $locale The plugin's current locale.
	 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
	 */
	$locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );

	$mofile = $domain . '-' . $locale . '.mo';

	// Try to load from the languages directory first.
	if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile ) ) {
		return true;
	}

	if ( false !== $plugin_rel_path ) {
		$path = WPMU_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/' );
	} else {
		$path = WPMU_PLUGIN_DIR;
	}

	return load_textdomain( $domain, $path . '/' . $mofile );
}

Код load plugin textdomain: wp-includes/l10n.php VER 4.9.7

<?php
function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
	/**
	 * Filters a plugin's locale.
	 *
	 * @since 3.0.0
	 *
	 * @param string $locale The plugin's current locale.
	 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
	 */
	$locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );

	$mofile = $domain . '-' . $locale . '.mo';

	// Try to load from the languages directory first.
	if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile ) ) {
		return true;
	}

	if ( false !== $plugin_rel_path ) {
		$path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/' );
	} elseif ( false !== $deprecated ) {
		_deprecated_argument( __FUNCTION__, '2.7.0' );
		$path = ABSPATH . trim( $deprecated, '/' );
	} else {
		$path = WP_PLUGIN_DIR;
	}

	return load_textdomain( $domain, $path . '/' . $mofile );
}

Cвязанные функции

Из метки: textdomain (файлы переводов po mo)

Еще из метки: localize (локализация Internationalization)

Еще из раздела: Локализация

Симуляторы игровых автоматов

Как начать играть в симуляторы игровых автоматов бесплатно и без регистрации расскажет dazzle.ru

dazzle.ru

3 коммента
  • А как переводить результат работы плагина? Я разобрался, что данным способом потом мы открываем потом .pot файл и в нем видим поля, которые доступны для перевода. В моем случае - это все поля, а точнее label полей и прочие названия, описания которые я вижу в админке. Но в админке плагином я создаю свои поля, в которые задаю названия кнопок допустим, label и прочие. От сюда вопрос, как переводить именно результат работы плагина, т.е. именно то, что он выводит на страницу?

    Ответить2.2 года назад #
    • Kama5406

      У меня нет статьи на эту тему, но в сети их хватает...

      Если коротко то так. В плагине используешь функции __() и _e(). Далее создаешь файлы переводов с помощью poedit или плагинов. Далее подключаешь эти файлы с помощью этой функции. И все, перевод готов...

      Ответить1.9 год назад #
Здравствуйте, !     Войти . Зарегистрироваться