wp_register_script()


WordPressのwp_register_script()関数は、JavaScriptファイルを登録するために使用されます。登録されたスクリプトは、後でwp_enqueue_script()を使って読み込むことができます。

構文

wp_register_script( string $handle, string $src, array $deps = array(), string|bool|null $ver = false, bool $in_footer = false );

引数の説明:

  • $handle (string) — スクリプトの識別子。ユニークである必要があります。
  • $src (string) — スクリプトのURL。
  • $deps (array) — このスクリプトが依存する他のスクリプトのハンドルの配列。
  • $ver (string|bool|null) — スクリプトのバージョン番号。キャッシュ対策に使用されます。
  • $in_footer (bool) — スクリプトをフッターに配置するかどうか。

例1: 基本的なスクリプトの登録

この例では、jQueryに依存するカスタムスクリプトを登録します。

wp_register_script('my-custom-script', get_template_directory_uri() . '/js/custom.js', array('jquery'), '1.0.0', true);

例2: スクリプトの登録と読み込み

スクリプトを登録し、すぐに読み込みます。

wp_register_script('my-script', get_template_directory_uri() . '/js/script.js'); wp_enqueue_script('my-script');

例3: バージョン番号の指定

バージョン番号を指定してスクリプトを登録します。

wp_register_script('versioned-script', get_template_directory_uri() . '/js/versioned.js', array(), '2.1.3');

例4: フッターに配置するスクリプト

スクリプトをフッターに配置する例です。

wp_register_script('footer-script', get_template_directory_uri() . '/js/footer.js', array(), '1.0.0', true);

例5: 依存関係の指定

複数の依存関係を持つスクリプトを登録します。

wp_register_script('dependent-script', get_template_directory_uri() . '/js/dependent.js', array('jquery', 'backbone'), '1.0.0');

例6: 条件付きスクリプトの登録

特定の条件下でのみスクリプトを登録します。

if (is_page('contact')) { wp_register_script('contact-script', get_template_directory_uri() . '/js/contact.js'); }

例7: 外部スクリプトの登録

外部のCDNからスクリプトを登録します。

wp_register_script('external-script', 'https://cdn.example.com/external.js');

例8: スクリプトの登録とローカライズ

スクリプトを登録し、ローカライズデータを追加します。

wp_register_script('localized-script', get_template_directory_uri() . '/js/localized.js'); wp_localize_script('localized-script', 'my_script_vars', array('ajax_url' => admin_url('admin-ajax.php')));

注意点:

  • スクリプトのハンドルはユニークである必要があります。
  • スクリプトを登録しても、自動的には読み込まれません。wp_enqueue_script()を使用して読み込む必要があります。
  • 依存関係を正しく指定しないと、スクリプトが正しい順序で読み込まれない可能性があります。

関連機能：