load_plugin_textdomain()

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

Загрузка переведенных строк плагина

/**
 * Загружает переведенные строки плагина.
 *
 * @param string $domain Обязательный. Уникальный идентификатор для получения переведенных строк.
 * @param string|false $deprecated Необязательный. Устаревший параметр. Вместо него используйте параметр $plugin_rel_path. По умолчанию: false.
 * @param string|false $plugin_rel_path Необязательный. Относительный путь к каталогу WP_PLUGIN_DIR, где находится файл .mo. По умолчанию: false.
 * @return bool Возвращает true, если textdomain успешно загружен, в противном случае - false.
 */
function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
    // Код загрузки переведенных строк плагина
}

Функция load_plugin_textdomain() используется для загрузки переведенных строк плагина. Она принимает три параметра: $domain, $deprecated и $plugin_rel_path. Параметр $domain является обязательным и представляет собой уникальный идентификатор для получения переведенных строк. Параметр $deprecated является необязательным и устаревшим, его использование не рекомендуется, вместо него следует использовать параметр $plugin_rel_path. Параметр $plugin_rel_path также является необязательным и представляет собой относительный путь к каталогу WP_PLUGIN_DIR, где находится файл .mo с переводом плагина.

Использование функции load_plugin_textdomain() для локализации плагина

/**
 * Загружает переведенные строки плагина для локализации.
 */
function load_plugin_textdomain_example() {
    $domain = 'my-plugin';
    $plugin_rel_path = 'languages';
    
    $loaded = load_plugin_textdomain( $domain, false, $plugin_rel_path );
    
    if ( $loaded ) {
        echo 'Переведенные строки плагина успешно загружены!';
    } else {
        echo 'Не удалось загрузить переведенные строки плагина.';
    }
}

В данном примере функция load_plugin_textdomain() используется для загрузки переведенных строк плагина с идентификатором 'my-plugin'. Параметр $plugin_rel_path указывает на каталог 'languages', где находится файл .mo с переводом плагина. Результат загрузки переведенных строк проверяется с помощью переменной $loaded, и в зависимости от результата выводится соответствующее сообщение.

Получение переведенных строк плагина с помощью load_plugin_textdomain()

/**
 * Получает переведенную строку плагина.
 */
function get_translated_string_example() {
    $domain = 'my-plugin';
    $plugin_rel_path = 'languages';
    
    $loaded = load_plugin_textdomain( $domain, false, $plugin_rel_path );
    
    if ( $loaded ) {
        $translated_string = __( 'Hello, world!', $domain );
        echo $translated_string;
    } else {
        echo 'Не удалось загрузить переведенные строки плагина.';
    }
}

В этом примере после успешной загрузки переведенных строк плагина, функция __() используется для получения переведенной строки с идентификатором 'Hello, world!' из плагина с идентификатором 'my-plugin'. Полученная переведенная строка выводится на экран.

Настройка пути к файлу .mo для перевода плагина с помощью load_plugin_textdomain()

/**
 * Загружает переведенные строки плагина с пользовательским путем к файлу .mo.
 */
function load_custom_mo_file_example() {
    $domain = 'my-plugin';
    $mo_file_path = '/path/to/my-plugin/languages/my-plugin-ru_RU.mo';
    
    $loaded = load_plugin_textdomain( $domain, false, $mo_file_path );
    
    if ( $loaded ) {
        echo 'Переведенные строки плагина успешно загружены!';
    } else {
        echo 'Не удалось загрузить переведенные строки плагина.';
    }
}

В данном примере функция load_plugin_textdomain() используется для загрузки переведенных строк плагина с идентификатором 'my-plugin'. В качестве пути к файлу .mo используется пользовательский путь '/path/to/my-plugin/languages/my-plugin-ru_RU.mo'. Результат загрузки переведенных строк проверяется с помощью переменной $loaded, и в зависимости от результата выводится соответствующее сообщение.

Проверка успешной загрузки переведенных строк плагина

/**
 * Проверяет успешную загрузку переведенных строк плагина.
 */
function check_translation_loaded_example() {
    $domain = 'my-plugin';
    $plugin_rel_path = 'languages';
    
    $loaded = load_plugin_textdomain( $domain, false, $plugin_rel_path );
    
    if ( $loaded ) {
        echo 'Переведенные строки плагина успешно загружены!';
    } else {
        echo 'Не удалось загрузить переведенные строки плагина.';
    }
}

В этом примере функция load_plugin_textdomain() используется для загрузки переведенных строк плагина с идентификатором 'my-plugin'. Результат загрузки переведенных строк проверяется с помощью переменной $loaded, и в зависимости от результата выводится соответствующее сообщение.