wp_set_script_translations

（5.0.0以降）
wp_set_script_translations - JavaScript向け翻訳ファイル情報を設定する

説明

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

関連

参考

Code Reference: wp_set_script_translations

お勧め

任意の名前でエラーログファイルを指定する（2019年2月15日 更新）

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する（2018年5月27日 更新）

テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。