wp_localize_script() の使い方説明・引数・注意点
wp_localize_script() は、登録済みのスクリプトに、PHPのデータをJavaScriptの変数として渡す関数です。
説明
wp_localize_script() は、登録済みのスクリプトに、PHPのデータをJavaScriptの変数として渡す関数です。
基本構文
wp_localize_script( string $handle, string $object_name, array $l10n ): bool
引数
$handle:対象のスクリプト識別名$object_name:JavaScript側のオブジェクト名$l10n:渡す値の配列
戻り値
成功すれば true。
使い方(サンプル)
wp_enqueue_script( 'my-script', get_theme_file_uri( 'js/app.js' ), array(), '1.0', true );
wp_localize_script( 'my-script', 'MyData', array(
'ajaxUrl' => admin_url( 'admin-ajax.php' ),
'nonce' => wp_create_nonce( 'my_action' ),
) );
注意点
- 先に
wp_enqueue_script()かwp_register_script()で登録しておく必要があります。 - 値は文字列に変換されます。数値や真偽値は、JS側で型変換が必要です。
- 型を保ったまま渡したい場合は、
wp_add_inline_script()とwp_json_encode()を使います。
実務での使いどころ
- PHPの値(Ajaxの送信先URL、nonceなど)を、JavaScriptへ渡すとき。
- 翻訳した文字列を、JavaScriptへ渡すとき。
よくあるミスと対策
- スクリプトを登録・読み込みする前に呼び、何も渡らない。対象のハンドルを、先に登録する。
- 配列のトップレベルにある、数値や真偽値は、文字列に変換される(ネストした配列の中は、型が保たれる)。型を保ちたいときは、
wp_add_inline_script()とwp_json_encode()を使う。 $object_nameが、JavaScriptのグローバル変数になる。他と重ならない名前にする。
NG例
wp_localize_script( 'my-script', 'myData', array( 'limit' => 10 ) ); // JavaScript側では、"10" の文字列になる
OK例
wp_add_inline_script(
'my-script',
'const myData = ' . wp_json_encode( array( 'limit' => 10 ) ) . ';',
'before'
);
使い分け早見表
| 関数 | 特徴 |
|---|---|
wp_localize_script() |
PHPの配列を、JavaScriptのオブジェクトとして渡す(トップレベルの数値・真偽値は、文字列になる) |
wp_add_inline_script() |
インラインのJavaScriptを追加する(型を保ったまま渡せる) |
wp_enqueue_script() |
スクリプトを読み込む |
PR エックスサーバー
WordPressを、速く・止まらずに運営したい方へ
サーバー選びを間違えると、表示が遅い・サイトが止まるリスクがあります
こんなお悩みはありませんか?
- どのレンタルサーバーを選べばよいか分からない
- 表示が遅い・サイトが落ちるのが心配
- WordPressの設定やセキュリティに自信がない
サーバーは、あとから乗り換えると、データの移行やドメインの設定に手間がかかります。表示が遅い、突然止まるといったトラブルは、訪問者が離れる原因にもなります。最初に、稼働率の保証や実績を確認して選ぶのが安全です。
エックスサーバーなら、WordPressの運営に強いレンタルサーバーを、迷わず選べます。国内でWordPressを利用して運用されているサイトの集計(Dataprovider.com調べ、2025年6月)で、国内シェアNo.1と公式サイトに記載されています。
選ばれるポイント
- WordPressサイトの国内シェアNo.1。実績で選びたいときの安心材料(Dataprovider.com調べ、2025年6月)
- サイトが止まりにくい。月間稼働率99.99%以上を保証し、下回ると月額費用の一部を返金
- 攻撃に強い。WordPressを狙った攻撃の99%以上を未然に防ぐ機能(2024年9月15日〜11月15日の当社調べ)
- ドメイン代を節約できる。独自ドメインが永久無料(対象ドメイン・契約期間などの条件あり)
- テーマ選びも安心。人気テーマ「Cocoon」の開発・提供元が運営
- 10日間の無料お試しで、契約前に操作や表示の速さを確かめられる
10日間の無料お試しで、契約前に試せます
10日間無料でお試し
広告(アフィリエイト)を含みます。特長は2026年11月8日時点の公式サイトの記載で、数値・順位は各調査・調べの時点のものです。料金・条件は公式サイトでご確認ください。
関連項目
wp_add_inline_script()、wp_enqueue_script()、wp_create_nonce()
公式リファレンス:wp_localize_script() | Function | WordPress Developer Resources
本記事は情報提供を目的としています。WordPress本体やテーマ・プラグインのバージョンによって動作が異なる場合があるため、本番環境に反映する前に、必ずテスト環境で動作を確認してください。