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

お勧め

任意の名前でエラーログファイルを指定する（2019年2月15日 更新）

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する（2018年5月27日 更新）

テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。