load_textdomain

（1.5.0以降）
load_textdomain - MOファイルをロードする

説明

bool load_textdomain( string $domain, string $mofile [ , string $locale = null ] )
国際化用ファイル（MOファイル）をロードする。

パラメータ

  • $domain
    ドメイン名を指定。
  • $mofile
    国際化用ファイル（MOファイル）のパス名を指定。
  • $locale
    [6.1.0]ロケールを指定（省略時はnull）。

返り値

指定された国際化用ファイル（MOファイル）をロードできた場合はtrueを、ロードできなかった場合はfalseを返す。

注意

ドメイン名は、 __関数や _e関数といった翻訳テキストを使用する際のパラメータとして指定する。

[6.3.0]'pre_load_textdomain'フィルターの返り値として、null以外（trueまたはfalse）を返すと、以降の処理は行われず、その値が本関数の返り値となる。

[6.5.0]国際化用ファイルとしてl10n.phpがサポートされたことに伴い'translation_file_format'フィルターが追加された。このフィルターでは'mo'または'php'を返す。'php'を返すことで、moファイルよりもl10n.phpファイルの方が優先的にロードされる。

[6.6.0]'translation_file_format'フィルターにパラメータ$localeが追加された。

使用例

  • テーマ内の国際化用ファイル（MOファイル）をロードする。
    <?php load_textdomain( 'mytheme', get_template_directory().'/'.get_locale().'.mo' ); ?>

フィルター

[6.3.0]はじめに'pre_load_textdomain'フィルターを呼び出す。$loadedの初期値はnullが、$domain、$mofile、$localeには本関数が受け取った内容が格納されている。 
$loaded = apply_filters( 'pre_load_textdomain', $loaded, $domain, $mofile, $locale );
[2.9.0]'pre_load_textdomain'フィルターの処理後に'override_load_textdomain'フィルターを呼び出す。パラメータ$overrideにはfalseが、$domainと$mofileには本関数が受け取った内容がが格納されている。[6.2.0]パラメータ$localeが追加され、本関数が受け取った内容がが格納されている。 
$plugin_override = apply_filters( 'override_load_textdomain', $override, $domain, $mofile, $locale );
[2.9.0]'load_textdomain'アクションの後に'load_textdomain_mofile'フィルターを呼び出す。パラメータ$mofileと$domainには本関数が受け取った内容がが格納されている。 
$mofile = apply_filters( 'load_textdomain_mofile', $mofile, $domain );
[6.5.0]国際化用ファイルをロードする前に'translation_file_format'フィルターを呼び出す。パラメータ$preferred_formatの初期値は'php'が、$domainには本関数が受け取った内容が格納されている。 
$preferred_format = apply_filters( 'translation_file_format', $preferred_format, $domain );
[6.5.0]国際化用ファイルをロードする直前に'load_translation_file'フィルターを呼び出す。パラメータ$fileにはファイルのパス名が、$domainには本関数が受け取った内容が格納されている。[6.6.0]パラメータ$localeが追加され、ロケールが格納されている。 
$file = (string) apply_filters( 'load_translation_file', $file, $domain, $locale );

アクション

[2.9.0]国際化用ファイルをロードする前に'load_textdomain'アクションを呼び出す。パラメータ$domainと$mofileには本関数が受け取った内容がが格納されている。 
do_action( 'load_textdomain', $domain, $mofile );

ソースファイル

/wp-includes/l10n.php

最終更新 : 2024年07月19日 16:29

関連

参考

Code Reference: load_textdomain

お勧め

edit_custom_thumbnail_sizesフィルターを使ってみた（2022年5月30日 更新）

アップロード済みの画像は、トリミングや回転、反転といった編集が可能である。6.0.0で追加されたedit_custom_thumbnail_sizesフィルターは、編集された内容を反映させるサイズを拡張するものだったので、さっそく使ってみた。

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧（2018年5月27日 更新）

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

投稿日の検索が自由自在に（2015年3月7日 更新）

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス（もちろん query_posts関数でも）で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

新テーマ「Twenty Twenty-Three」にはfunctions.phpがない（2022年10月6日 更新）

WordPress 6.1に同梱された新テーマ「Twenty Twenty-Three」を見てみると、そこには見慣れたfunctions.phpがない。Full Site Editing（FSE）対応テーマってこんな感じなのかと思いつつ、テーマの設定がどうなっているのか調べてみた。

WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日 更新）

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。