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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$idstring

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.Default: ''

$depsarrayoptional

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

$argsarrayoptional

Default: array()

Performance profile

How much work a call to wp_enqueue_script_module() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

15

Executed per call on PHP 8.5. The body compiles to 15.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

13

13 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_enqueue_script_module() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• wp_script_modules()Retrieves the main WP_Script_Modules instance.
• wp_script_modules()::enqueue()

Used by · 13

• WP_Block::render()Generates the render output for the block.
• WP_Navigation_Block_Renderer::handle_view_script_module_loading()Handle view script module loading.
• render_block_core_file()When the `core/file` block is rendering, check if we need to enqueue the `wp-block-file-view` script.
• render_block_core_image()Renders the `core/image` block on the server, adding a data-id attribute to the element if core/gallery has added on pre-render.
• render_block_core_playlist()Renders the `core/playlist` block on server.
• render_block_core_query()Modifies the static `core/query` block on the server.
• render_block_core_search()Dynamically renders the `core/search` block.
• wp_enqueue_block_editor_script_modules()Enqueues script modules required by the block editor.
• wp_font_library_render_page()Render the font-library page.
• wp_font_library_wp_admin_enqueue_scripts()Enqueue scripts and styles for the font-library-wp-admin page.
• wp_options_connectors_render_page()Render the options-connectors page.
• wp_options_connectors_wp_admin_enqueue_scripts()Enqueue scripts and styles for the options-connectors-wp-admin page.

Source code

View on Trac ↗View on GitHub ↗

115function wp_enqueue_script_module( string $id, string $src = '', array $deps = array(), $version = false, array $args = array() ) {116	wp_script_modules()->enqueue( $id, $src, $deps, $version, $args );117}

Changelog

Introduced in 6.5.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/script-modules.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.