スクリプトを登録し、読み込み対象としてキューに追加します。キューに追加されたスクリプトは、wp_head() や wp_footer() が出力されるタイミングで自動的に読み込まれ、サイトに適用されます。
wp_enqueue_script($handle,$src,$deps,$ver,$args);| 引数 | 必須/任意 | 引数に指定するもの |
|---|---|---|
| 第1引数 $handle | 必須 | スクリプトのハンドル名(文字列)※ハンドル名はスクリプトに割り当てる固有の名前です。 |
| 第2引数 $src | 任意 | スクリプトのパス(文字列)初期値: '' (空の文字列) |
| 第3引数 $deps | 任意 | このスクリプトが依存する他のスクリプトのハンドル名(配列)初期値: [] (空の配列)※他のスクリプトのハンドル名を指定するとそのスクリプトよりも後に呼び出されます。 |
| 第4引数 $ver | 任意 | スクリプトのバージョン(文字列)初期値: false |
| 第5引数 $args | 任意 | 【真偽値で指定する場合】 スクリプトをwp_footer()で出力する場合は true、wp_head()で出力する場合はfalse初期値: false 【配列で指定する場合】 他のオプションと合わせて配列で指定も可能。 strategy:'async' / 'defer'in_footer:'false' (wp_footer()で出力するならtrue)例 [初期値: [] (空の配列) |
スクリプトを登録し、読み込み対象としてキューに追加します。
下記の例では、get_theme_file_uri()を使ってテーマ直下にあるjsディレクトリ内のscript.jsをキューに追加しています。第5引数がtrueのため、キューに追加されたjsはwp_footer()で呼び出されます。
wp_enqueue_script('main', get_theme_file_uri('/js/script.js'), ['swiper'], '1.0', true);【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。
【引数について】
下記の例では、2つのCSSをwp_enqueue_style()で、2つのJavaScriptをwp_enqueue_script()でキューに追加しています。
function my_theme_scripts() {
wp_enqueue_style('main', get_theme_file_uri('/css/style.min.css'), ['swiper'], '2.1');
wp_enqueue_style('swiper', get_theme_file_uri('/lib/swiper/swiper.min.css'), [], '1.1');
wp_enqueue_script('main', get_theme_file_uri('/js/script.js'), ['swiper'], '1.0', true);
wp_enqueue_script('swiper', get_theme_file_uri('/lib/swiper/swiper-bundle.min.js'), [], '1.0', true);
}
add_action('wp_enqueue_scripts', 'my_theme_scripts');このコードを実行すると下記のようにscript要素がwp_footer()で呼び出されます。なお、swiper.jsはswiper-bundle.min.jsに依存する指定なので(依存関係を指定する第3引数でswiperを指定)、見た目の順番通りではなく、swiper.jsはswiper-bundle.min.jsの後に呼び出されます。
結果例:<script type="text/javascript" src="https://example.com/wp-content/themes/template-theme/lib/swiper/swiper-bundle.min.js?ver=1.0" id="swiper-js"></script><script type="text/javascript" src="https://example.com/wp-content/themes/template-theme/js/script.js?ver=1.0" id="main-js"></script>
※cssは割愛しています。
※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。