wp_enqueue_script()


WordPress関数wp_enqueue_script()は、テーマやプラグインでスクリプトを正しく追加するために使用されます。この関数を使うことで、スクリプトの競合や重複を防ぐことができます。

構文

wp_enqueue_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: シンプルなスクリプトの登録

以下のコードは、スクリプトをテーマに追加します。

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

例2: 依存関係を指定してスクリプトを登録

他のスクリプトに依存するスクリプトを登録します。

wp_enqueue_script( 'custom-script', get_template_directory_uri() . '/js/custom-script.js', array( 'jquery' ) );

例3: バージョンを指定してスクリプトを登録

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

wp_enqueue_script( 'custom-script', get_template_directory_uri() . '/js/custom-script.js', array(), '1.0.0' );

例4: フッターにスクリプトを登録

スクリプトをフッターに読み込む設定で登録します。

wp_enqueue_script( 'custom-script', get_template_directory_uri() . '/js/custom-script.js', array(), '1.0.0', true );

例5: 条件付きでスクリプトを登録

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

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

注意事項

  • wp_enqueue_script()を使用する際は、wp_enqueue_scriptsアクションフックで呼び出してください。
  • 依存関係が正しく解決されていない場合、スクリプトが正しく動作しない可能性があります。
  • フッターにスクリプトを読み込む場合、テーマがwp_footer()を使用している必要があります。

関連機能：