wp_register_script()

関数の概要

wp_register_script()は、WordPressでJavaScriptファイルをキューに追加せずに登録するための関数です。この関数を使用すると、スクリプトを必要なタイミングで簡単にキューに追加できるようになります。スクリプトを複数の場所で使用する場合や、条件に基づいてスクリプトを読み込む場合に便利です。

パラメータの説明

wp_register_script()関数は6つのパラメータを受け取ります。

  1. $handle (string, 必須): スクリプトの一意の識別子。
  2. $src (string, 必須): スクリプトのURL。URLを指定しない場合、登録済みのスクリプトが使用されます。
  3. $deps (array, オプション): スクリプトの依存関係を示すハンドルの配列。デフォルトは空の配列です。
  4. $ver (string|bool|null, オプション): スクリプトのバージョン番号。デフォルトはfalseです。バージョン番号を指定しない場合、WordPressのバージョンが使用されます。
  5. $in_footer (bool, オプション): trueの場合、スクリプトをページのフッターに出力します。デフォルトはfalse（ヘッダーに出力）です。

使用例

以下は、wp_register_script()関数を使用してJavaScriptファイルを登録し、その後にキューに追加する例です。

<?php
function my_register_scripts() {
    // カスタムスクリプトを登録する
    wp_register_script(
        'my-custom-script', // ハンドル
        get_template_directory_uri() . '/js/custom-script.js', // スクリプトのURL
        array('jquery'), // 依存関係（例：jQuery）
        '1.0.0', // バージョン番号
        true // フッターに出力する
    );
}
add_action('wp_enqueue_scripts', 'my_register_scripts');

function my_enqueue_registered_scripts() {
    // 登録済みのスクリプトをキューに追加する
    wp_enqueue_script('my-custom-script');
}
add_action('wp_enqueue_scripts', 'my_enqueue_registered_scripts', 11);
?>

条件に基づいてスクリプトをキューに追加する例

<?php
function my_conditional_scripts() {
    // カスタムスクリプトを登録する
    wp_register_script(
        'conditional-script', // ハンドル
        get_template_directory_uri() . '/js/conditional-script.js', // スクリプトのURL
        array(), // 依存関係なし
        '1.0.0', // バージョン番号
        true // フッターに出力する
    );

    // 特定のページでスクリプトをキューに追加する
    if (is_page('contact')) {
        wp_enqueue_script('conditional-script');
    }
}
add_action('wp_enqueue_scripts', 'my_conditional_scripts');
?>

関連する関数

  • wp_enqueue_script(): JavaScriptファイルをキューに登録し、読み込みます。
  • wp_register_style(): CSSファイルをキューに追加せずに登録します。
  • wp_enqueue_style(): CSSファイルをキューに登録し、読み込みます。
  • wp_deregister_script(): キューからスクリプトを解除します。
  • wp_deregister_style(): キューからスタイルシートを解除します。

使用上の注意

  • wp_register_script()関数は、スクリプトを登録するだけで、実際にはキューに追加しません。スクリプトをキューに追加するには、別途wp_enqueue_script()関数を呼び出す必要があります。
  • 依存関係を適切に指定することで、スクリプトの競合や読み込み順序の問題を防ぐことができます。
  • wp_enqueue_scriptsアクションフックを使用してスクリプトを登録およびキューに追加することで、WordPressの適切なタイミングでスクリプトが読み込まれるようにします。
スポンサーリンク