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

[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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。