load_textdomain

説明

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ファイルの方が優先的にロードされる。


使用例

  • テーマ内の国際化用ファイル(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には本関数が受け取った内容が格納されている。
$file = (string) apply_filters( 'load_translation_file', $file, $domain );

アクション

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

ソースファイル

/wp-includes/l10n.php

最終更新 : 2024年04月04日 09:23



お勧め

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。