WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_register_script_module()

wp_register_script_module( string $id, string $src, array $deps = array(), string|false|null $version = false )

In this article

Back to top

Registers the script module if no script module with that script module identifier has already been registered.

Parameters

$idstringrequired
The identifier of the script module. Should be unique. It will be used in the final import map.
$srcstringoptional
Full URL of the script module, or path of the script module relative to the WordPress root directory. If it is provided and the script module has not been registered yet, it will be registered.
$depsarrayoptional
List of dependencies.
  • ...$0 string|array
    An array of script module identifiers of the dependencies of this script module. The dependencies can be strings or arrays. If they are arrays, they need an id key with the script module identifier, and can contain an import key with either static or dynamic. By default, dependencies that don’t contain an import key are considered static.
    • id string
      The script module identifier.
    • import string
      Optional. Import type. May be either static or dynamic. Defaults to static.

Default:array()

$versionstring|false|nulloptional
String specifying the script module version number. Defaults to false.
It is added to the URL as a query string for cache busting purposes. If $version is set to false, the version number is the currently installed WordPress version.
If $version is set to null, no version is added.

Default:false

Source

function wp_register_script_module( string $id, string $src, array $deps = array(), $version = false ) {
	wp_script_modules()->register( $id, $src, $deps, $version );
}

View all references View on Trac View on GitHub

UsesDescription
WP_Script_Modules::register()wp-includes/class-wp-script-modules.php

Registers the script module if no script module with that script module identifier has already been registered.

wp_script_modules()wp-includes/script-modules.php

Retrieves the main WP_Script_Modules instance.

Used byDescription
wp_default_script_modules()wp-includes/script-modules.php

Registers all the default WordPress Script Modules.

register_block_script_module_id()wp-includes/blocks.php

Finds a script module ID for the selected block metadata field. It detects when a path to file was provided and optionally finds a corresponding asset file with details necessary to register the script module under with an automatically generated module ID. It returns unprocessed script module ID otherwise.

Changelog

VersionDescription
6.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.