WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_register_script_module()

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

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.
string|bool> $args { Optional. An array of additional args. Default empty array.
@type bool $in_footer Whether to print the script module in the footer. Only relevant to block themes. Default 'false'. Optional.
@type 'auto'|'low'|'high' $fetchpriority Fetch priority. Default 'auto'. Optional.
}
$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, array $args = array() ) {
	wp_script_modules()->register( $id, $src, $deps, $version, $args );
}

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_register_page_routes()wp-includes/build/routes.php

Generic helper function to register routes for a page.

wp_options_connectors_wp_admin_enqueue_scripts()wp-includes/build/pages/options-connectors/page-wp-admin.php

Enqueue scripts and styles for the options-connectors-wp-admin page.

wp_options_connectors_render_page()wp-includes/build/pages/options-connectors/page.php

Render the options-connectors page.

wp_font_library_render_page()wp-includes/build/pages/font-library/page.php

Render the font-library page.

wp_font_library_wp_admin_enqueue_scripts()wp-includes/build/pages/font-library/page-wp-admin.php

Enqueue scripts and styles for the font-library-wp-admin page.

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.

Show 2 moreShow less

Changelog

VersionDescription
6.9.0Added the $args parameter.
6.5.0Introduced.

User Contributed Notes

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