функция
since 1.5.0
load_plugin_textdomain()
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
load_plugin_textdomain( string $domain, string|false $deprecated = false, string|false $plugin_rel_path = false ): boolОписание
Если путь не указан, используется корень каталога плагина.
.mo-файл должен называться по текстовому домену, за которым через дефис следует точное имя локали.
Оригинал (английский)
If the path is not given then it will be the root of the plugin directory.
The .mo file should be named based on the text domain with a dash, and then the locale exactly.
Параметры
$domain
string
обязательный
Уникальный идентификатор для получения переведённых строк
$deprecated
string|false
необязательный
= false
Устаревший. Вместо него используйте параметр $plugin_rel_path.
$plugin_rel_path
string|false
необязательный
= false
Относительный путь к WP_PLUGIN_DIR, где находится .mo-файл.
Возвращаемое значение
bool
Исходный код
wp-includes/l10n.php:999
function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
/** @var WP_Textdomain_Registry $wp_textdomain_registry */
/** @var array<string, WP_Translations|NOOP_Translations> $l10n */
global $wp_textdomain_registry, $l10n;
if ( ! is_string( $domain ) ) {
return false;
}
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;
}
$wp_textdomain_registry->set_custom_path( $domain, $path );
// If just-in-time loading was triggered before, reset the entry so it can be tried again.
if ( isset( $l10n[ $domain ] ) && $l10n[ $domain ] instanceof NOOP_Translations ) {
unset( $l10n[ $domain ] );
}
return true;
}История изменений
| Версия | Описание |
|---|---|
| 6.7.0 | Translations are no longer immediately loaded, but handed off to the just-in-time loading mechanism. |
| 4.6.0 | The function now tries to load the .mo file from the languages directory first. |
| 1.5.0 | Introduced. |
