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

お勧め

プラグインのロード順を制御する（2014年6月9日 更新）

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化：カスタムフィールドキーの条件指定が使いやすくなる（2019年11月19日 更新）

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する（2019年5月14日 更新）

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

「順序」をtextからnumberに変更してみた（2018年5月27日 更新）

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。