<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Script Modules API: WP_Script_Modules class.

[2] Fix | Delete

*

[3] Fix | Delete

* Native support for ES Modules and Import Maps.

[4] Fix | Delete

*

[5] Fix | Delete

* @package WordPress

[6] Fix | Delete

* @subpackage Script Modules

[7] Fix | Delete

*/

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Core class used to register script modules.

[11] Fix | Delete

*

[12] Fix | Delete

* @since 6.5.0

[13] Fix | Delete

*/

[14] Fix | Delete

class WP_Script_Modules {

[15] Fix | Delete

/**

[16] Fix | Delete

* Holds the registered script modules, keyed by script module identifier.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 6.5.0

[19] Fix | Delete

* @var array[]

[20] Fix | Delete

*/

[21] Fix | Delete

private $registered = array();

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Holds the script module identifiers that were enqueued before registered.

[25] Fix | Delete

*

[26] Fix | Delete

* @since 6.5.0

[27] Fix | Delete

* @var array<string, true>

[28] Fix | Delete

*/

[29] Fix | Delete

private $enqueued_before_registered = array();

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Registers the script module if no script module with that script module

[33] Fix | Delete

* identifier has already been registered.

[34] Fix | Delete

*

[35] Fix | Delete

* @since 6.5.0

[36] Fix | Delete

*

[37] Fix | Delete

* @param string $id The identifier of the script module. Should be unique. It will be used in the

[38] Fix | Delete

* final import map.

[39] Fix | Delete

* @param string $src Optional. Full URL of the script module, or path of the script module relative

[40] Fix | Delete

* to the WordPress root directory. If it is provided and the script module has

[41] Fix | Delete

* not been registered yet, it will be registered.

[42] Fix | Delete

* @param array $deps {

[43] Fix | Delete

* Optional. List of dependencies.

[44] Fix | Delete

*

[45] Fix | Delete

* @type string|array ...$0 {

[46] Fix | Delete

* An array of script module identifiers of the dependencies of this script

[47] Fix | Delete

* module. The dependencies can be strings or arrays. If they are arrays,

[48] Fix | Delete

* they need an `id` key with the script module identifier, and can contain

[49] Fix | Delete

* an `import` key with either `static` or `dynamic`. By default,

[50] Fix | Delete

* dependencies that don't contain an `import` key are considered static.

[51] Fix | Delete

*

[52] Fix | Delete

* @type string $id The script module identifier.

[53] Fix | Delete

* @type string $import Optional. Import type. May be either `static` or

[54] Fix | Delete

* `dynamic`. Defaults to `static`.

[55] Fix | Delete

* }

[56] Fix | Delete

* }

[57] Fix | Delete

* @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.

[58] Fix | Delete

* It is added to the URL as a query string for cache busting purposes. If $version

[59] Fix | Delete

* is set to false, the version number is the currently installed WordPress version.

[60] Fix | Delete

* If $version is set to null, no version is added.

[61] Fix | Delete

*/

[62] Fix | Delete

public function register( string $id, string $src, array $deps = array(), $version = false ) {

[63] Fix | Delete

if ( ! isset( $this->registered[ $id ] ) ) {

[64] Fix | Delete

$dependencies = array();

[65] Fix | Delete

foreach ( $deps as $dependency ) {

[66] Fix | Delete

if ( is_array( $dependency ) ) {

[67] Fix | Delete

if ( ! isset( $dependency['id'] ) ) {

[68] Fix | Delete

_doing_it_wrong( __METHOD__, __( 'Missing required id key in entry among dependencies array.' ), '6.5.0' );

[69] Fix | Delete

continue;

[70] Fix | Delete

}

[71] Fix | Delete

$dependencies[] = array(

[72] Fix | Delete

'id' => $dependency['id'],

[73] Fix | Delete

'import' => isset( $dependency['import'] ) && 'dynamic' === $dependency['import'] ? 'dynamic' : 'static',

[74] Fix | Delete

);

[75] Fix | Delete

} elseif ( is_string( $dependency ) ) {

[76] Fix | Delete

$dependencies[] = array(

[77] Fix | Delete

'id' => $dependency,

[78] Fix | Delete

'import' => 'static',

[79] Fix | Delete

);

[80] Fix | Delete

} else {

[81] Fix | Delete

_doing_it_wrong( __METHOD__, __( 'Entries in dependencies array must be either strings or arrays with an id key.' ), '6.5.0' );

[82] Fix | Delete

}

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

$this->registered[ $id ] = array(

[86] Fix | Delete

'src' => $src,

[87] Fix | Delete

'version' => $version,

[88] Fix | Delete

'enqueue' => isset( $this->enqueued_before_registered[ $id ] ),

[89] Fix | Delete

'dependencies' => $dependencies,

[90] Fix | Delete

);

[91] Fix | Delete

}

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Marks the script module to be enqueued in the page.

[96] Fix | Delete

*

[97] Fix | Delete

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

[98] Fix | Delete

* will be registered.

[99] Fix | Delete

*

[100] Fix | Delete

* @since 6.5.0

[101] Fix | Delete

*

[102] Fix | Delete

* @param string $id The identifier of the script module. Should be unique. It will be used in the

[103] Fix | Delete

* final import map.

[104] Fix | Delete

* @param string $src Optional. Full URL of the script module, or path of the script module relative

[105] Fix | Delete

* to the WordPress root directory. If it is provided and the script module has

[106] Fix | Delete

* not been registered yet, it will be registered.

[107] Fix | Delete

* @param array $deps {

[108] Fix | Delete

* Optional. List of dependencies.

[109] Fix | Delete

*

[110] Fix | Delete

* @type string|array ...$0 {

[111] Fix | Delete

* An array of script module identifiers of the dependencies of this script

[112] Fix | Delete

* module. The dependencies can be strings or arrays. If they are arrays,

[113] Fix | Delete

* they need an `id` key with the script module identifier, and can contain

[114] Fix | Delete

* an `import` key with either `static` or `dynamic`. By default,

[115] Fix | Delete

* dependencies that don't contain an `import` key are considered static.

[116] Fix | Delete

*

[117] Fix | Delete

* @type string $id The script module identifier.

[118] Fix | Delete

* @type string $import Optional. Import type. May be either `static` or

[119] Fix | Delete

* `dynamic`. Defaults to `static`.

[120] Fix | Delete

* }

[121] Fix | Delete

* }

[122] Fix | Delete

* @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.

[123] Fix | Delete

* It is added to the URL as a query string for cache busting purposes. If $version

[124] Fix | Delete

* is set to false, the version number is the currently installed WordPress version.

[125] Fix | Delete

* If $version is set to null, no version is added.

[126] Fix | Delete

*/

[127] Fix | Delete

public function enqueue( string $id, string $src = '', array $deps = array(), $version = false ) {

[128] Fix | Delete

if ( isset( $this->registered[ $id ] ) ) {

[129] Fix | Delete

$this->registered[ $id ]['enqueue'] = true;

[130] Fix | Delete

} elseif ( $src ) {

[131] Fix | Delete

$this->register( $id, $src, $deps, $version );

[132] Fix | Delete

$this->registered[ $id ]['enqueue'] = true;

[133] Fix | Delete

} else {

[134] Fix | Delete

$this->enqueued_before_registered[ $id ] = true;

[135] Fix | Delete

}

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

/**

[139] Fix | Delete

* Unmarks the script module so it will no longer be enqueued in the page.

[140] Fix | Delete

*

[141] Fix | Delete

* @since 6.5.0

[142] Fix | Delete

*

[143] Fix | Delete

* @param string $id The identifier of the script module.

[144] Fix | Delete

*/

[145] Fix | Delete

public function dequeue( string $id ) {

[146] Fix | Delete

if ( isset( $this->registered[ $id ] ) ) {

[147] Fix | Delete

$this->registered[ $id ]['enqueue'] = false;

[148] Fix | Delete

}

[149] Fix | Delete

unset( $this->enqueued_before_registered[ $id ] );

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Removes a registered script module.

[154] Fix | Delete

*

[155] Fix | Delete

* @since 6.5.0

[156] Fix | Delete

*

[157] Fix | Delete

* @param string $id The identifier of the script module.

[158] Fix | Delete

*/

[159] Fix | Delete

public function deregister( string $id ) {

[160] Fix | Delete

unset( $this->registered[ $id ] );

[161] Fix | Delete

unset( $this->enqueued_before_registered[ $id ] );

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Adds the hooks to print the import map, enqueued script modules and script

[166] Fix | Delete

* module preloads.

[167] Fix | Delete

*

[168] Fix | Delete

* In classic themes, the script modules used by the blocks are not yet known

[169] Fix | Delete

* when the `wp_head` actions is fired, so it needs to print everything in the

[170] Fix | Delete

* footer.

[171] Fix | Delete

*

[172] Fix | Delete

* @since 6.5.0

[173] Fix | Delete

*/

[174] Fix | Delete

public function add_hooks() {

[175] Fix | Delete

$position = wp_is_block_theme() ? 'wp_head' : 'wp_footer';

[176] Fix | Delete

add_action( $position, array( $this, 'print_import_map' ) );

[177] Fix | Delete

add_action( $position, array( $this, 'print_enqueued_script_modules' ) );

[178] Fix | Delete

add_action( $position, array( $this, 'print_script_module_preloads' ) );

[179] Fix | Delete

[180] Fix | Delete

add_action( 'admin_print_footer_scripts', array( $this, 'print_import_map' ) );

[181] Fix | Delete

add_action( 'admin_print_footer_scripts', array( $this, 'print_enqueued_script_modules' ) );

[182] Fix | Delete

add_action( 'admin_print_footer_scripts', array( $this, 'print_script_module_preloads' ) );

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

/**

[186] Fix | Delete

* Prints the enqueued script modules using script tags with type="module"

[187] Fix | Delete

* attributes.

[188] Fix | Delete

*

[189] Fix | Delete

* @since 6.5.0

[190] Fix | Delete

*/

[191] Fix | Delete

public function print_enqueued_script_modules() {

[192] Fix | Delete

foreach ( $this->get_marked_for_enqueue() as $id => $script_module ) {

[193] Fix | Delete

wp_print_script_tag(

[194] Fix | Delete

array(

[195] Fix | Delete

'type' => 'module',

[196] Fix | Delete

'src' => $this->get_src( $id ),

[197] Fix | Delete

'id' => $id . '-js-module',

[198] Fix | Delete

)

[199] Fix | Delete

);

[200] Fix | Delete

}

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

/**

[204] Fix | Delete

* Prints the the static dependencies of the enqueued script modules using

[205] Fix | Delete

* link tags with rel="modulepreload" attributes.

[206] Fix | Delete

*

[207] Fix | Delete

* If a script module is marked for enqueue, it will not be preloaded.

[208] Fix | Delete

*

[209] Fix | Delete

* @since 6.5.0

[210] Fix | Delete

*/

[211] Fix | Delete

public function print_script_module_preloads() {

[212] Fix | Delete

foreach ( $this->get_dependencies( array_keys( $this->get_marked_for_enqueue() ), array( 'static' ) ) as $id => $script_module ) {

[213] Fix | Delete

// Don't preload if it's marked for enqueue.

[214] Fix | Delete

if ( true !== $script_module['enqueue'] ) {

[215] Fix | Delete

echo sprintf(

[216] Fix | Delete

'<link rel="modulepreload" href="%s" id="%s">',

[217] Fix | Delete

esc_url( $this->get_src( $id ) ),

[218] Fix | Delete

esc_attr( $id . '-js-modulepreload' )

[219] Fix | Delete

);

[220] Fix | Delete

}

[221] Fix | Delete

}

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

/**

[225] Fix | Delete

* Prints the import map using a script tag with a type="importmap" attribute.

[226] Fix | Delete

*

[227] Fix | Delete

* @since 6.5.0

[228] Fix | Delete

*

[229] Fix | Delete

* @global WP_Scripts $wp_scripts The WP_Scripts object for printing the polyfill.

[230] Fix | Delete

*/

[231] Fix | Delete

public function print_import_map() {

[232] Fix | Delete

$import_map = $this->get_import_map();

[233] Fix | Delete

if ( ! empty( $import_map['imports'] ) ) {

[234] Fix | Delete

global $wp_scripts;

[235] Fix | Delete

if ( isset( $wp_scripts ) ) {

[236] Fix | Delete

wp_print_inline_script_tag(

[237] Fix | Delete

wp_get_script_polyfill(

[238] Fix | Delete

$wp_scripts,

[239] Fix | Delete

array(

[240] Fix | Delete

'HTMLScriptElement.supports && HTMLScriptElement.supports("importmap")' => 'wp-polyfill-importmap',

[241] Fix | Delete

)

[242] Fix | Delete

),

[243] Fix | Delete

array(

[244] Fix | Delete

'id' => 'wp-load-polyfill-importmap',

[245] Fix | Delete

)

[246] Fix | Delete

);

[247] Fix | Delete

}

[248] Fix | Delete

wp_print_inline_script_tag(

[249] Fix | Delete

wp_json_encode( $import_map, JSON_HEX_TAG | JSON_HEX_AMP ),

[250] Fix | Delete

array(

[251] Fix | Delete

'type' => 'importmap',

[252] Fix | Delete

'id' => 'wp-importmap',

[253] Fix | Delete

)

[254] Fix | Delete

);

[255] Fix | Delete

}

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

/**

[259] Fix | Delete

* Returns the import map array.

[260] Fix | Delete

*

[261] Fix | Delete

* @since 6.5.0

[262] Fix | Delete

*

[263] Fix | Delete

* @return array Array with an `imports` key mapping to an array of script module identifiers and their respective

[264] Fix | Delete

* URLs, including the version query.

[265] Fix | Delete

*/

[266] Fix | Delete

private function get_import_map(): array {

[267] Fix | Delete

$imports = array();

[268] Fix | Delete

foreach ( $this->get_dependencies( array_keys( $this->get_marked_for_enqueue() ) ) as $id => $script_module ) {

[269] Fix | Delete

$imports[ $id ] = $this->get_src( $id );

[270] Fix | Delete

}

[271] Fix | Delete

return array( 'imports' => $imports );

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete

/**

[275] Fix | Delete

* Retrieves the list of script modules marked for enqueue.

[276] Fix | Delete

*

[277] Fix | Delete

* @since 6.5.0

[278] Fix | Delete

*

[279] Fix | Delete

* @return array[] Script modules marked for enqueue, keyed by script module identifier.

[280] Fix | Delete

*/

[281] Fix | Delete

private function get_marked_for_enqueue(): array {

[282] Fix | Delete

$enqueued = array();

[283] Fix | Delete

foreach ( $this->registered as $id => $script_module ) {

[284] Fix | Delete

if ( true === $script_module['enqueue'] ) {

[285] Fix | Delete

$enqueued[ $id ] = $script_module;

[286] Fix | Delete

}

[287] Fix | Delete

}

[288] Fix | Delete

return $enqueued;

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

/**

[292] Fix | Delete

* Retrieves all the dependencies for the given script module identifiers,

[293] Fix | Delete

* filtered by import types.

[294] Fix | Delete

*

[295] Fix | Delete

* It will consolidate an array containing a set of unique dependencies based

[296] Fix | Delete

* on the requested import types: 'static', 'dynamic', or both. This method is

[297] Fix | Delete

* recursive and also retrieves dependencies of the dependencies.

[298] Fix | Delete

*

[299] Fix | Delete

* @since 6.5.0

[300] Fix | Delete

*

[301] Fix | Delete

* @param string[] $ids The identifiers of the script modules for which to gather dependencies.

[302] Fix | Delete

* @param string[] $import_types Optional. Import types of dependencies to retrieve: 'static', 'dynamic', or both.

[303] Fix | Delete

* Default is both.

[304] Fix | Delete

* @return array[] List of dependencies, keyed by script module identifier.

[305] Fix | Delete

*/

[306] Fix | Delete

private function get_dependencies( array $ids, array $import_types = array( 'static', 'dynamic' ) ) {

[307] Fix | Delete

return array_reduce(

[308] Fix | Delete

$ids,

[309] Fix | Delete

function ( $dependency_script_modules, $id ) use ( $import_types ) {

[310] Fix | Delete

$dependencies = array();

[311] Fix | Delete

foreach ( $this->registered[ $id ]['dependencies'] as $dependency ) {

[312] Fix | Delete

if (

[313] Fix | Delete

in_array( $dependency['import'], $import_types, true ) &&

[314] Fix | Delete

isset( $this->registered[ $dependency['id'] ] ) &&

[315] Fix | Delete

! isset( $dependency_script_modules[ $dependency['id'] ] )

[316] Fix | Delete

) {

[317] Fix | Delete

$dependencies[ $dependency['id'] ] = $this->registered[ $dependency['id'] ];

[318] Fix | Delete

}

[319] Fix | Delete

}

[320] Fix | Delete

return array_merge( $dependency_script_modules, $dependencies, $this->get_dependencies( array_keys( $dependencies ), $import_types ) );

[321] Fix | Delete

},

[322] Fix | Delete

array()

[323] Fix | Delete

);

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

/**

[327] Fix | Delete

* Gets the versioned URL for a script module src.

[328] Fix | Delete

*

[329] Fix | Delete

* If $version is set to false, the version number is the currently installed

[330] Fix | Delete

* WordPress version. If $version is set to null, no version is added.

[331] Fix | Delete

* Otherwise, the string passed in $version is used.

[332] Fix | Delete

*

[333] Fix | Delete

* @since 6.5.0

[334] Fix | Delete

*

[335] Fix | Delete

* @param string $id The script module identifier.

[336] Fix | Delete

* @return string The script module src with a version if relevant.

[337] Fix | Delete

*/

[338] Fix | Delete

private function get_src( string $id ): string {

[339] Fix | Delete

if ( ! isset( $this->registered[ $id ] ) ) {

[340] Fix | Delete

return '';

[341] Fix | Delete

}

[342] Fix | Delete

[343] Fix | Delete

$script_module = $this->registered[ $id ];

[344] Fix | Delete

$src = $script_module['src'];

[345] Fix | Delete

[346] Fix | Delete

if ( false === $script_module['version'] ) {

[347] Fix | Delete

$src = add_query_arg( 'ver', get_bloginfo( 'version' ), $src );

[348] Fix | Delete

} elseif ( null !== $script_module['version'] ) {

[349] Fix | Delete

$src = add_query_arg( 'ver', $script_module['version'], $src );

[350] Fix | Delete

}

[351] Fix | Delete

[352] Fix | Delete

/**

[353] Fix | Delete

* Filters the script module source.

[354] Fix | Delete

*

[355] Fix | Delete

* @since 6.5.0

[356] Fix | Delete

*

[357] Fix | Delete

* @param string $src Module source URL.

[358] Fix | Delete

* @param string $id Module identifier.

[359] Fix | Delete

*/

[360] Fix | Delete

$src = apply_filters( 'script_module_loader_src', $src, $id );

[361] Fix | Delete

[362] Fix | Delete

return $src;

[363] Fix | Delete

}

[364] Fix | Delete

}

[365] Fix | Delete