wp_localize_script

（2.2.0以降）
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

関連

参考

Code Reference: wp_localize_script

お勧め

カスタムフィールド関連関数のおさらい（2012年6月22日 更新）

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

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

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

Login rebuilderのログ表示機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

メタボックスをクラシックエディターのみで表示する（2019年1月15日 更新）

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。