WP_Script_Modules

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 2

Every hook that fires from inside WP_Script_Modules, in the order it appears in the class, grouped by the method that fires it.

Properties · 7

$registeredarray<string,private

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

$queuestring[]private

An array of IDs for queued script modules.

$donestring[]private

Holds the script module identifiers that have been printed.

$a11y_availableboolprivate

Tracks whether the @wordpress/a11y script module is available.

$dependents_maparray<string,private

Holds a mapping of dependents (as IDs) for a given script ID.

$prioritiesstring[]private

Holds the valid values for fetchpriority.

$modules_with_missing_dependenciesstring[]private

List of IDs for script modules encountered which have missing dependencies.

Methods · 28

• register()Registers the script module if no script module with that script module identifier has already been registered.
• get_queue()Gets IDs for queued script modules.
• is_valid_fetchpriority()Checks if the provided fetchpriority is valid.
• set_fetchpriority()Sets the fetch priority for a script module.
• set_in_footer()Sets whether a script module should be printed in the footer.
• enqueue()Marks the script module to be enqueued in the page.
• dequeue()Unmarks the script module so it will no longer be enqueued in the page.
• deregister()Removes a registered script module.
• set_translations()Overrides the text domain and path used to load translations for a script module.
• print_script_module_translations()Prints translations for all enqueued script modules.
• add_hooks()Adds the hooks to print the import map, enqueued script modules and script module preloads.
• get_highest_fetchpriority()Gets the highest fetch priority for the provided script IDs.
• print_head_enqueued_script_modules()Prints the enqueued script modules in head.
• print_enqueued_script_modules()Prints the enqueued script modules in footer.
• print_script_module()Prints the enqueued script module using script tags with type="module" attributes.
• print_script_module_preloads()Prints the static dependencies of the enqueued script modules using link tags with rel="modulepreload" attributes.
• print_import_map()Prints the import map using a script tag with a type="importmap" attribute.
• get_import_map()Returns the import map array.
• get_marked_for_enqueue()Retrieves the list of script modules marked for enqueue.
• get_dependencies()Retrieves all the dependencies for the given script module identifiers, filtered by import types.
• get_dependents()Gets all dependents of a script module.
• get_recursive_dependents()Gets all recursive dependents of a script module.
• get_sorted_dependencies()Sorts the given script module identifiers based on their dependencies.
• sort_item_dependencies()Recursively sorts the dependencies for a single script module identifier.
• get_registered()Gets the data for a registered script module.
• get_src()Gets the versioned URL for a script module src.
• print_script_module_data()Print data associated with Script Modules.
• print_a11y_script_module_html()

Source code

View on Trac ↗View on GitHub ↗

26class WP_Script_Modules {27	/**28	 * Holds the registered script modules, keyed by script module identifier.29	 *30	 * @since 6.5.031	 * @var array<string, array<string, mixed>>32	 * @phpstan-var array<string, ScriptModule>33	 */34	private $registered = array();35 36	/**37	 * An array of IDs for queued script modules.38	 *39	 * @since 6.9.040	 * @var string[]41	 */42	private $queue = array();43 44	/**45	 * Holds the script module identifiers that have been printed.46	 *47	 * @since 6.9.048	 * @var string[]49	 */50	private $done = array();51 52	/**53	 * Tracks whether the @wordpress/a11y script module is available.54	 *55	 * Some additional HTML is required on the page for the module to work. Track56	 * whether it's available to print at the appropriate time.57	 *58	 * @since 6.7.059	 * @var bool60	 */61	private $a11y_available = false;62 63	/**64	 * Holds a mapping of dependents (as IDs) for a given script ID.65	 * Used to optimize recursive dependency tree checks.66	 *67	 * @since 6.9.068	 * @var array<string, string[]>69	 */70	private $dependents_map = array();71 72	/**73	 * Holds the valid values for fetchpriority.74	 *75	 * @since 6.9.076	 * @var string[]77	 */78	private $priorities = array(79		'low',80		'auto',81		'high',82	);83 84	/**85	 * List of IDs for script modules encountered which have missing dependencies.86	 *87	 * An ID is added to this list when it is discovered to have missing dependencies. At this time, a warning is88	 * emitted with {@see _doing_it_wrong()}. The ID is then added to this list, so that duplicate warnings don't occur.89	 *90	 * @since 6.9.191	 * @var string[]92	 */93	private $modules_with_missing_dependencies = array();94 95	/**96	 * Registers the script module if no script module with that script module97	 * identifier has already been registered.98	 *99	 * @since 6.5.0100	 * @since 6.9.0 Added the $args parameter.101	 *102	 * @param string                              $id      The identifier of the script module. Should be unique. It will be used in the103	 *                                                     final import map.104	 * @param string                              $src     Optional. Full URL of the script module, or path of the script module relative105	 *                                                     to the WordPress root directory. If it is provided and the script module has

Changelog

Introduced in 6.5.0. 14 changes 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/class-wp-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.