WP_Script_Modules::enqueue( string $id, string $src = '', array $deps = array(), string|false|null $version = false )

Marks the script module to be enqueued in the page the next time print_enqueued_script_modules is called.

Description

If a src is provided and the script module has not been registered yet, it will be registered.

Parameters

$id

(Required) The identifier of the script module. Should be unique. It will be used in the final import map.

$src

(Optional) 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 value: ''

$deps

(Optional) List of dependencies.<br>

  • '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.<br>
    • 'id'
      (string) The script module identifier.<br>
    • 'import'
      (string) Optional. Import type. May be either static or dynamic. Defaults to static.<br>

Default value: array()

$version

(Optional) String specifying the script module version number. Defaults to false.<br> 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.<br> If $version is set to null, no version is added.

Default value: false

Source

File: wp-includes/class-wp-script-modules.php 

	public function enqueue( string $id, string $src = '', array $deps = array(), $version = false ) {
		if ( isset( $this->registered[ $id ] ) ) {
			$this->registered[ $id ]['enqueue'] = true;
		} elseif ( $src ) {
			$this->register( $id, $src, $deps, $version );
			$this->registered[ $id ]['enqueue'] = true;
		} else {
			$this->enqueued_before_registered[ $id ] = true;
		}
	}

Expand Source Code View on GitHub

Related

Uses

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

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

Used By

Used By
Used By Description
wp-includes/script-modules.php: wp_enqueue_script_module()

Marks the script module to be enqueued in the page.

Changelog

Changelog
Version Description
6.5.0 Introduced.