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



お勧め

投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 更新)

rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

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

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

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。

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

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