wp_set_script_translations

説明

bool wp_set_script_translations( string $handle [ , string $domain = 'default' [ , string $path = null ] ] )
JavaScript向け翻訳ファイル情報を設定する。

パラメータ

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

返り値

翻訳ファイル情報を設定できた場合はtrueを返す。設定できなかった場合はfalseを返す。


注意

本関数はテーマやプラグインのJavaScriptファイル向けの翻訳ファイルを設定する。この関数は情報の設定だけであり、翻訳ファイルの読み込みは load_script_textdomain関数が行う。JavaScript向け翻訳ファイルのファイル名は、「ドメイン名-ロケール名-ハンドル名.json」か「ドメイン名-ロケール名-md5ハッシュ値.json」となる(md5ハッシュ値は対象のJavaScriptファイルのパス名の一部から生成)。

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


使用例

  • プラグイン内のJavaScript向け翻訳ファイルを設定する。
    <?php wp_set_script_translations( 'myplugin-script', 'myplugin-domain', dirname( __FILE__ ) . '/languages' ); ?>
  • プラグイン内のJavaScript向け翻訳ファイルを設定する。
    <?php
    $block_json = json_decode( file_get_contents( dirname( __FILE__ ) . '/build/blocks/myblock/block.json' ) );
    $script_handle = generate_block_asset_handle( $block_json->name, 'editorScript' );
    wp_set_script_translations( $script_handle, 'myplugin-domain', dirname( __FILE__ ) . '/languages' );
    ?>

フィルター

実行するフィルターはありません。

アクション

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

ソースファイル

/wp-includes/functions.wp-scripts.php

最終更新 : 2024年05月04日 14:55



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

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

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

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

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

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