wp_localize_script

説明

bool wp_localize_script( string $handle, string $object_name, array $l10n )
スクリプト向けの変数を追加する。

パラメータ

  • $handle
    スクリプトのハンドル名を指定。
  • $object_name
    変数名(JavaScriptで使用できるもの)を指定。
  • $l10n
    変数のデータを指定。

返り値

変数を追加できた場合はtrueを、追加できなかった場合はfalseを返す。

注意

本関数はパラメータ$handleで指定したスクリプトが登録されている場合にそのスクリプトで使用する変数を追加する(スクリプトが登録されていない場合は変数は追加されない)。なお変数の内容はローカライズ(多言語対応)を限定するものではない。


使用例

  • 'myscript'向けの変数を追加する。
    <?php
    wp_localize_script( 'myscript', 'myscriptData', array(
    	'nonce' => wp_create_nonce( 'myscript' ),
    	'updated' => __( 'Setting updated', 'mydomain' )
    	) );
    ?>

フィルター

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

アクション

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

ソースファイル

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

最終更新 : 2018年05月27日 10:43



お勧め

スクリプトファイルのバージョンパラメータを変更する(2018年5月27日 更新)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。