load_script_textdomain

（5.0.0以降）
load_script_textdomain - JavaScript向け翻訳ファイルを読み込む

説明

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

関連

参考

Code Reference: load_script_textdomain

お勧め

投稿情報を連想配列で参照する（2018年5月27日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日 更新）

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。

続テーマを変更せずにWebフォントを使ってみた（2022年2月8日 更新）

先日投稿した「テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Twenty One」でWebフォントを使うことができた。その後、ほかのテーマで試したところ、そのままではWebフォントを使うことができなかった。今回は、それらのテーマの対応について紹介する。

ブロックエディターで現在の「ロケール」を取得した時のメモ（2024年8月10日 更新）

ブロックエディター向けのプラグインで日本語固有の機能を実装する際、現在のロケール（言語）を取得したい。ブロックエディターの編集時、投稿を編集しているユーザーの言語が優先され、それをどうやって取得するかを「ChatGPT」に聞いてみたのだが。。。

スマートフォン向けの振り分けを自前で行う（2012年1月23日 更新）

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。