load_plugin_textdomain()


WordPress関数load_plugin_textdomain()は、プラグインの翻訳ファイルをロードし、国際化を実現するために使用されます。この関数を使用することで、プラグインの多言語対応を実現できます。

構文

load_plugin_textdomain( string $domain, string $deprecated = '', string $plugin_rel_path = '' );

引数の説明

  • $domain (string) — 翻訳ファイルで使用されるテキストドメイン。
  • $deprecated (string) — 廃止予定の引数（使用しないこと）。
  • $plugin_rel_path (string) — 翻訳ファイルが存在するプラグインディレクトリへの相対パス。

例1: プラグインの翻訳ファイルをロード

以下の例は、プラグインディレクトリ内のlanguagesフォルダから翻訳ファイルをロードします。

load_plugin_textdomain( 'my-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );

例2: テキストドメインのみを指定

テキストドメインを指定して翻訳をロードする基本的な例。

load_plugin_textdomain( 'my-plugin' );

例3: プラグインの別フォルダにある翻訳ファイルをロード

カスタムフォルダから翻訳ファイルをロードします。

load_plugin_textdomain( 'my-plugin', false, 'custom-folder/languages' );

例4: 翻訳ファイルをテーマ互換でロード

プラグインの翻訳ファイルがテーマの互換フォルダにある場合。

load_plugin_textdomain( 'my-plugin', false, trailingslashit( get_template_directory() ) . 'plugins/my-plugin/languages' );

例5: プラグイン初期化時にロード

プラグイン初期化フックを使用して翻訳をロードします。

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

注意事項

  • $deprecated引数は使用しないでください。
  • 翻訳ファイルは通常、.mo形式で保存されます。

関連機能：