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

お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

管理画面の'アイキャッチ画像'を'写真'に変える（2013年1月23日 更新）

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

5.7の機能拡張：投稿一覧画面向けのフィルター（2021年2月18日 更新）

昨日、予定通り公開された「WordPress 5.7 Beta 3（以降Beta 3）」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

タイトルのみをキーワード検索する（2014年4月3日 更新）

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。