load_script_textdomain

説明

string|false load_script_textdomain( string $handle [ , string $domain = 'default' [ , string $path = null ] ] )
JavaScript向け翻訳ファイルを読み込む。

パラメータ

  • $handle
    JavaScriptのハンドル名を指定。
  • $domain
    ドメイン名を指定([5.1.0]省略時'default')。
  • $path
    翻訳ファイル(.json)があるディレクトリのフルパス名を指定(省略時null)。

返り値

翻訳ファイルが見つかった場合はその内容を返す。見つからなかった場合はfalseを返す。


注意

本関数はテーマやプラグインが wp_set_script_translations関数を使用した場合に呼び出される。JavaScript向け翻訳ファイルのファイル名は、「ドメイン名-ロケール名-ハンドル名.json」か「ドメイン名-ロケール名-md5ハッシュ値.json」となる(md5ハッシュ値は対象のJavaScriptファイルのパス名の一部から生成)。

[5.0.2]'script_loader_src'フィルターがなくなり、'load_script_textdomain_relative_path'フィルターが追加された。また翻訳ファイルの読み込みは load_script_translations関数が使用されるように変更された。

[5.1.0]第2パラメータ$domainが省略可能になった。


使用例

  • プラグイン内のJavaScript向け翻訳ファイルを読み込む。
    <?php $content = load_script_textdomain( 'myplugin-script', 'myplugin-domain', dirname( __FILE__ ) . '/languages' ); ?>

フィルター

[5.0.2]JavaScriptファイルの相対パス名を確定したら'load_script_textdomain_relative_path'フィルターを呼び出す。パラメータ$relativeにはJavaScriptファイルの相対パス名が、$srcにはJavaScriptファイルのURLが格納されている。
$relative = apply_filters( 'load_script_textdomain_relative_path', $relative, $src );
[5.0.0]$pathで指定されたディレクトリに翻訳ファイルが存在しなかった場合に'script_loader_src'フィルターを呼び出す。パラメータ$srcにはハンドル名に紐づけられたJavaScriptファイルのパス名が、$handleには本関数が受け取った内容が格納されている。
$src = esc_url( apply_filters( 'script_loader_src', $src, $handle ) );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/l10n.php

最終更新 : 2019年02月26日 10:18



お勧め

Gutenberg、「新規追加」に難あり(2018年10月25日 更新)

昨日公開した「Gutenberg、初見です」で自作プラグインの「複製」機能が正しく動作していないことについて軽く触れた。該当するプラグインを修正するにしても原因がはっきりしないと手の打ちようがない。そんなわけで、不具合の原因を調べてみた。

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

index.htmlでアーカイブページを表示させる(2011年10月14日 更新)

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた(こんなことを考えてるのは自分だけだろうか!?)。

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。