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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。