wp_register_script_module()


WordPressのwp_register_script_module()関数は、JavaScriptモジュールを登録するために使用されます。この関数を使うことで、モジュールを他のスクリプトやモジュールから依存関係として利用できるようになります。

構文

wp_register_script_module( string $handle, string $src, array $deps = array(), string|bool|null $version = false, array|string $args = array() );

引数の説明:

  • $handle (string) — モジュールの識別子。他のスクリプトやモジュールから参照するために使用されます。
  • $src (string) — モジュールのURL。モジュールのソースファイルへのパスを指定します。
  • $deps (array) — このモジュールが依存する他のモジュールやスクリプトのハンドルの配列。
  • $version (string|bool|null) — モジュールのバージョン。キャッシュ対策に使用されます。
  • $args (array|string) — モジュールの追加オプション。例えば、モジュールの読み込み方法を指定できます。

例1: 基本的なモジュールの登録

この例では、my-moduleというハンドルでモジュールを登録します。

wp_register_script_module( 'my-module', get_template_directory_uri() . '/js/my-module.js' );

例2: 依存関係を持つモジュールの登録

この例では、my-moduleがanother-moduleに依存するように登録します。

wp_register_script_module( 'my-module', get_template_directory_uri() . '/js/my-module.js', array( 'another-module' ) );

例3: バージョンを指定してモジュールを登録

この例では、モジュールにバージョン番号を指定して登録します。

wp_register_script_module( 'my-module', get_template_directory_uri() . '/js/my-module.js', array(), '1.0.0' );

例4: モジュールを条件付きで登録

この例では、特定の条件下でのみモジュールを登録します。

if ( is_page( 'contact' ) ) { wp_register_script_module( 'my-module', get_template_directory_uri() . '/js/my-module.js' ); }

例5: モジュールをフッターで読み込む

この例では、モジュールをフッターで読み込むように指定します。

wp_register_script_module( 'my-module', get_template_directory_uri() . '/js/my-module.js', array(), false, array( 'in_footer' => true ) );

例6: モジュールを非同期で読み込む

この例では、モジュールを非同期で読み込むように指定します。

wp_register_script_module( 'my-module', get_template_directory_uri() . '/js/my-module.js', array(), false, array( 'async' => true ) );

例7: モジュールを遅延読み込みする

この例では、モジュールを遅延読み込みするように指定します。

wp_register_script_module( 'my-module', get_template_directory_uri() . '/js/my-module.js', array(), false, array( 'defer' => true ) );

例8: モジュールを登録して即時にエンキュー

この例では、モジュールを登録し、即時にエンキューします。

wp_register_script_module( 'my-module', get_template_directory_uri() . '/js/my-module.js' ); wp_enqueue_script_module( 'my-module' );

注意点

  • モジュールの登録は、wp_enqueue_scriptsアクションフック内で行うことが推奨されます。
  • モジュールの依存関係を正しく設定しないと、読み込み順序が正しくならない場合があります。
  • モジュールのURLは、絶対パスまたは相対パスで指定する必要があります。

関連機能：