Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

JavaScript: Add new Modules API. 

This changeset adds a new API for WordPress, designed to work with native ES Modules and Import Maps. It introduces functions such as `wp_register_module`, and `wp_enqueue_module`.

The API aims to provide a familiar experience to the existing `WP_Scripts` class, offering similar functionality. However, **it's not intended to duplicate the exact functionality of `WP_Scripts`**; rather, it is carefully tailored to address the specific needs and capabilities of ES modules.

For this initial version, **the current proposal is intentionally simplistic**, covering only the essential features needed to work with ES modules. Other enhancements and optimizations can be added later as the community identifies additional requirements and use cases.

== Differences Between WP_Script_Modules and WP_Scripts

=== Dependency Specification

With `WP_Script_Modules`, the array of dependencies supports not only strings but also arrays that include the dependency import type (`static` or `dynamic`). This design choice allows for future extensions of dependency properties, such as adding a `version` property to support "scopes" within import maps.

=== Module Identifier

Instead of a handle, `WP_Script_Modules` utilizes the module identifier, aligning with the module identifiers used in JavaScript files and import maps.

=== Deregistration

There is no equivalent of `wp_deregister_script` at this stage.

== API

=== `wp_register_module( $module_identifier, $src, $deps, $version )`

Registers a module.

{{{
// Registers a module with dependencies and versioning.
wp_register_module(
  'my-module',
  '/path/to/my-module.js',
  array( 'static-dependency-1', 'static-dependency-2' ),
  '1.2.3'
);
}}}

{{{
// my-module.js
import { ... } from 'static-dependency-1';
import { ... } from 'static-dependency-2';

// ...
}}}

{{{
// Registers a module with a dynamic dependency.
wp_register_module(
  'my-module',
  '/path/to/my-module.js',
  array(
    'static-dependency',
    array(
      'id'     => 'dynamic-dependency',
      'import' => 'dynamic'
    ),
  )
);
}}}

{{{
// my-module.js
import { ... } from 'static-dependency';

// ...
const dynamicModule = await import('dynamic-dependency');
}}}

=== `wp_enqueue_module( $module_identifier, $src, $deps, $version )`

Enqueues a module. If a source is provided, it will also register the module.

{{{
wp_enqueue_module( 'my-module' );
}}}

=== `wp_dequeue_module( $module_identifier )`

Dequeues a module.

{{{
wp_dequeue_module( 'my-module' );
}}}

== Output

- When modules are enqueued, they are printed within script tags containing `type="module"` attributes.
- Additionally, static dependencies of enqueued modules utilize `link` tags with `rel="modulepreload"` attributes.
- Lastly, an import map is generated and inserted using a `<script type="importmap">` tag.

{{{
<script type="module" src="/path/to/my-module.js" id="my-module"></script>
<link rel="modulepreload" href="/path/to/static-dependency.js" id="static-dependency" />
<script type="importmap">
  {
    "imports": {
      "static-dependency": "/path/to/static-dependency.js",
      "dynamic-dependency": "/path/to/dynamic-dependency.js"
    }
  }
</script>
}}}

== Import Map Polyfill Requirement

Even though all major browsers already support import maps, an import map polyfill is required until the percentage of users using old browser versions without import map support drops significantly.

This work is ongoing and will be added once it's ready. Progress is tracked in #60232.

Props luisherranz, idad5, costdev, neffff, joemcgill, jorbin, swissspidy, jonsurrell, flixos90, gziolo, westonruter.
Fixes #56313.
Built from https://develop.svn.wordpress.org/trunk@57269


git-svn-id: http://core.svn.wordpress.org/trunk@56775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Bernhard Reiter 2024-01-11 14:47:14 +00:00
parent c9291ac596
commit 36f543f447
4 changed files with 471 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

352
wp-includes/class-wp-script-modules.php Normal file
View File

@ -0,0 +1,352 @@
<?php
/**
* Modules API: WP_Script_Modules class.
*
* Native support for ES Modules and Import Maps.
*
* @package WordPress
* @subpackage Script Modules
*/
/**
* Core class used to register modules.
*
* @since 6.5.0
*/
class WP_Script_Modules {
/**
* Holds the registered modules, keyed by module identifier.
*
* @since 6.5.0
* @var array
*/
private $registered = array();
/**
* Holds the module identifiers that were enqueued before registered.
*
* @since 6.5.0
* @var array
*/
private $enqueued_before_registered = array();
/**
* Registers the module if no module with that module identifier has already
* been registered.
*
* @since 6.5.0
*
* @param string $module_id The identifier of the module.
* Should be unique. It will be used
* in the final import map.
* @param string $src Full URL of the module, or path of
* the module relative to the
* WordPress root directory.
* @param array<string|array{id: string, import?: 'static'|'dynamic' }> $deps Optional. An array of module
* identifiers of the dependencies of
* this module. The dependencies can
* be strings or arrays. If they are
* arrays, they need an `id` key with
* the 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.
* @param string|false|null $version Optional. String specifying the
* 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.
*/
public function register( $module_id, $src, $deps = array(), $version = false ) {
if ( ! isset( $this->registered[ $module_id ] ) ) {
$dependencies = array();
foreach ( $deps as $dependency ) {
if ( is_array( $dependency ) ) {
if ( ! isset( $dependency['id'] ) ) {
_doing_it_wrong( __METHOD__, __( 'Missing required id key in entry among dependencies array.' ), '6.5.0' );
continue;
}
$dependencies[] = array(
'id' => $dependency['id'],
'import' => isset( $dependency['import'] ) && 'dynamic' === $dependency['import'] ? 'dynamic' : 'static',
);
} elseif ( is_string( $dependency ) ) {
$dependencies[] = array(
'id' => $dependency,
'import' => 'static',
);
} else {
_doing_it_wrong( __METHOD__, __( 'Entries in dependencies array must be either strings or arrays with an id key.' ), '6.5.0' );
}
}
$this->registered[ $module_id ] = array(
'src' => $src,
'version' => $version,
'enqueue' => isset( $this->enqueued_before_registered[ $module_id ] ),
'dependencies' => $dependencies,
'enqueued' => false,
'preloaded' => false,
);
}
}
/**
* Marks the module to be enqueued in the page the next time
* `prints_enqueued_modules` is called.
*
* If a src is provided and the module has not been registered yet, it will be
* registered.
*
* @since 6.5.0
*
* @param string $module_id The identifier of the module.
* Should be unique. It will be used
* in the final import map.
* @param string $src Optional. Full URL of the module,
* or path of the module relative to
* the WordPress root directory. If
* it is provided and the module has
* not been registered yet, it will be
* registered.
* @param array<string|array{id: string, import?: 'static'|'dynamic' }> $deps Optional. An array of module
* identifiers of the dependencies of
* this module. The dependencies can
* be strings or arrays. If they are
* arrays, they need an `id` key with
* the 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.
* @param string|false|null $version Optional. String specifying the
* 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.
*/
public function enqueue( $module_id, $src = '', $deps = array(), $version = false ) {
if ( isset( $this->registered[ $module_id ] ) ) {
$this->registered[ $module_id ]['enqueue'] = true;
} elseif ( $src ) {
$this->register( $module_id, $src, $deps, $version );
$this->registered[ $module_id ]['enqueue'] = true;
} else {
$this->enqueued_before_registered[ $module_id ] = true;
}
}
/**
* Unmarks the module so it will no longer be enqueued in the page.
*
* @since 6.5.0
*
* @param string $module_id The identifier of the module.
*/
public function dequeue( $module_id ) {
if ( isset( $this->registered[ $module_id ] ) ) {
$this->registered[ $module_id ]['enqueue'] = false;
}
unset( $this->enqueued_before_registered[ $module_id ] );
}
/**
* Adds the hooks to print the import map, enqueued modules and module
* preloads.
*
* It adds the actions to print the enqueued modules and module preloads to
* both `wp_head` and `wp_footer` because in classic themes, the modules
* used by the theme and plugins will likely be able to be printed in the
* `head`, but the ones used by the blocks will need to be enqueued in the
* `footer`.
*
* As all modules are deferred and dependencies are handled by the browser,
* the order of the modules is not important, but it's still better to print
* the ones that are available when the `wp_head` is rendered, so the browser
* starts downloading those as soon as possible.
*
* The import map is also printed in the footer to be able to include the
* dependencies of all the modules, including the ones printed in the footer.
*
* @since 6.5.0
*/
public function add_hooks() {
add_action( 'wp_head', array( $this, 'print_enqueued_modules' ) );
add_action( 'wp_head', array( $this, 'print_module_preloads' ) );
add_action( 'wp_footer', array( $this, 'print_enqueued_modules' ) );
add_action( 'wp_footer', array( $this, 'print_module_preloads' ) );
add_action( 'wp_footer', array( $this, 'print_import_map' ) );
}
/**
* Prints the enqueued modules using script tags with type="module"
* attributes.
*
* If a enqueued module has already been printed, it will not be printed again
* on subsequent calls to this function.
*
* @since 6.5.0
*/
public function print_enqueued_modules() {
foreach ( $this->get_marked_for_enqueue() as $module_id => $module ) {
if ( false === $module['enqueued'] ) {
// Mark it as enqueued so it doesn't get enqueued again.
$this->registered[ $module_id ]['enqueued'] = true;
wp_print_script_tag(
array(
'type' => 'module',
'src' => $this->get_versioned_src( $module ),
'id' => $module_id . '-js-module',
)
);
}
}
}
/**
* Prints the the static dependencies of the enqueued modules using link tags
* with rel="modulepreload" attributes.
*
* If a module is marked for enqueue, it will not be preloaded. If a preloaded
* module has already been printed, it will not be printed again on subsequent
* calls to this function.
*
* @since 6.5.0
*/
public function print_module_preloads() {
foreach ( $this->get_dependencies( array_keys( $this->get_marked_for_enqueue() ), array( 'static' ) ) as $module_id => $module ) {
// Don't preload if it's marked for enqueue or has already been preloaded.
if ( true !== $module['enqueue'] && false === $module['preloaded'] ) {
// Mark it as preloaded so it doesn't get preloaded again.
$this->registered[ $module_id ]['preloaded'] = true;
echo sprintf(
'<link rel="modulepreload" href="%s" id="%s">',
esc_url( $this->get_versioned_src( $module ) ),
esc_attr( $module_id . '-js-modulepreload' )
);
}
}
}
/**
* Prints the import map using a script tag with a type="importmap" attribute.
*
* @since 6.5.0
*/
public function print_import_map() {
$import_map = $this->get_import_map();
if ( ! empty( $import_map['imports'] ) ) {
wp_print_inline_script_tag(
wp_json_encode( $import_map, JSON_HEX_TAG | JSON_HEX_AMP ),
array(
'type' => 'importmap',
'id' => 'wp-importmap',
)
);
}
}
/**
* Returns the import map array.
*
* @since 6.5.0
*
* @return array Array with an `imports` key mapping to an array of module identifiers and their respective URLs,
* including the version query.
*/
private function get_import_map() {
$imports = array();
foreach ( $this->get_dependencies( array_keys( $this->get_marked_for_enqueue() ) ) as $module_id => $module ) {
$imports[ $module_id ] = $this->get_versioned_src( $module );
}
return array( 'imports' => $imports );
}
/**
* Retrieves the list of modules marked for enqueue.
*
* @since 6.5.0
*
* @return array Modules marked for enqueue, keyed by module identifier.
*/
private function get_marked_for_enqueue() {
$enqueued = array();
foreach ( $this->registered as $module_id => $module ) {
if ( true === $module['enqueue'] ) {
$enqueued[ $module_id ] = $module;
}
}
return $enqueued;
}
/**
* Retrieves all the dependencies for the given module identifiers, filtered
* by import types.
*
* It will consolidate an array containing a set of unique dependencies based
* on the requested import types: 'static', 'dynamic', or both. This method is
* recursive and also retrieves dependencies of the dependencies.
*
* @since 6.5.0
*
* @param array $module_ids The identifiers of the modules for which to gather dependencies.
* @param array $import_types Optional. Import types of dependencies to retrieve: 'static', 'dynamic', or both.
* Default is both.
* @return array List of dependencies, keyed by module identifier.
*/
private function get_dependencies( $module_ids, $import_types = array( 'static', 'dynamic' ) ) {
return array_reduce(
$module_ids,
function ( $dependency_modules, $module_id ) use ( $import_types ) {
$dependencies = array();
foreach ( $this->registered[ $module_id ]['dependencies'] as $dependency ) {
if (
in_array( $dependency['import'], $import_types, true ) &&
isset( $this->registered[ $dependency['id'] ] ) &&
! isset( $dependency_modules[ $dependency['id'] ] )
) {
$dependencies[ $dependency['id'] ] = $this->registered[ $dependency['id'] ];
}
}
return array_merge( $dependency_modules, $dependencies, $this->get_dependencies( array_keys( $dependencies ), $import_types ) );
},
array()
);
}
/**
* Gets the versioned URL for a module src.
*
* 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.
* Otherwise, the string passed in $version is used.
*
* @since 6.5.0
*
* @param array $module The module.
* @return string The module src with a version if relevant.
*/
private function get_versioned_src( array $module ) {
$args = array();
if ( false === $module['version'] ) {
$args['ver'] = get_bloginfo( 'version' );
} elseif ( null !== $module['version'] ) {
$args['ver'] = $module['version'];
}
if ( $args ) {
return add_query_arg( $args, $module['src'] );
}
return $module['src'];
}
}

116
wp-includes/script-modules.php Normal file
View File

@ -0,0 +1,116 @@
<?php
/**
* Script Modules API: Module functions
*
* @since 6.5.0
*
* @package WordPress
* @subpackage Script Modules
*/
/**
* Retrieves the main WP_Script_Modules instance.
*
* This function provides access to the WP_Script_Modules instance, creating one
* if it doesn't exist yet.
*
* @since 6.5.0
*
* @return WP_Script_Modules The main WP_Script_Modules instance.
*/
function wp_modules() {
static $instance = null;
if ( is_null( $instance ) ) {
$instance = new WP_Script_Modules();
$instance->add_hooks();
}
return $instance;
}
/**
* Registers the module if no module with that module identifier has already
* been registered.
*
* @since 6.5.0
*
* @param string $module_id The identifier of the module.
* Should be unique. It will be used
* in the final import map.
* @param string $src Full URL of the module, or path of
* the module relative to the
* WordPress root directory.
* @param array<string|array{id: string, import?: 'static'|'dynamic' }> $deps Optional. An array of module
* identifiers of the dependencies of
* this module. The dependencies can
* be strings or arrays. If they are
* arrays, they need an `id` key with
* the 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.
* @param string|false|null $version Optional. String specifying the
* 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.
*/
function wp_register_module( $module_id, $src, $deps = array(), $version = false ) {
wp_modules()->register( $module_id, $src, $deps, $version );
}
/**
* Marks the module to be enqueued in the page.
*
* If a src is provided and the module has not been registered yet, it will be
* registered.
*
* @since 6.5.0
*
* @param string $module_id The identifier of the module.
* Should be unique. It will be used
* in the final import map.
* @param string $src Optional. Full URL of the module,
* or path of the module relative to
* the WordPress root directory. If
* it is provided and the module has
* not been registered yet, it will be
* registered.
* @param array<string|array{id: string, import?: 'static'|'dynamic' }> $deps Optional. An array of module
* identifiers of the dependencies of
* this module. The dependencies can
* be strings or arrays. If they are
* arrays, they need an `id` key with
* the 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.
* @param string|false|null $version Optional. String specifying the
* 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.
*/
function wp_enqueue_module( $module_id, $src = '', $deps = array(), $version = false ) {
wp_modules()->enqueue( $module_id, $src, $deps, $version );
}
/**
* Unmarks the module so it is no longer enqueued in the page.
*
* @since 6.5.0
*
* @param string $module_id The identifier of the module.
*/
function wp_dequeue_module( $module_id ) {
wp_modules()->dequeue( $module_id );
}

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.5-alpha-57268';
$wp_version = '6.5-alpha-57269';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

2
wp-settings.php
View File

@ -365,6 +365,8 @@ require ABSPATH . WPINC . '/style-engine/class-wp-style-engine-processor.php';
require ABSPATH . WPINC . '/fonts/class-wp-font-face-resolver.php';
require ABSPATH . WPINC . '/fonts/class-wp-font-face.php';
require ABSPATH . WPINC . '/fonts.php';
require ABSPATH . WPINC . '/class-wp-script-modules.php';
require ABSPATH . WPINC . '/script-modules.php';
$GLOBALS['wp_embed'] = new WP_Embed();