mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-04-01 03:04:34 +00:00
Script Modules API: Rename wp_module to wp_script_module
Renames all mentions to "module" with "script module", including function names, comments, and tests. Follow up to [57269] The list of functions renamed are: - `wp_module()` -> `wp_script_module()`. - `wp_register_module()` -> `wp_register_script_module()`. - `wp_enqueue_module()` -> `wp_enqueue_script_module()`. - `wp_dequeue_module()` -> `wp_dequeue_script_module()`. - `WP_Script_Modules::print_enqueued_modules()` -> `WP_Script_Modules::print_enqueued_script_modules()`. - `WP_Script_Modules::print_module_preloads()` -> `WP_Script_Modules::print_script_module_preloads()`. It also adds PHP 7 typing to all the functions and improves the types of the `$deps` argument of `wp_register_script_module()` and `wp_enqueue_script_module()` using `@type`. Props luisherranz, idad5, costdev, nefff, joemcgill, jorbin, swisspidy, jonsurrel, flixos90, gziolo, westonruter, bernhard-reiter, kamranzafar4343 See #56313 git-svn-id: https://develop.svn.wordpress.org/trunk@57327 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Dennis Snell
@@ -1,6 +1,6 @@
|
||||
<?php
|
||||
/**
|
||||
* Script Modules API: Module functions
|
||||
* Script Modules API: Script Module functions
|
||||
*
|
||||
* @since 6.5.0
|
||||
*
|
||||
@@ -18,7 +18,7 @@
|
||||
*
|
||||
* @return WP_Script_Modules The main WP_Script_Modules instance.
|
||||
*/
|
||||
function wp_modules() {
|
||||
function wp_script_modules(): WP_Script_Modules {
|
||||
static $instance = null;
|
||||
if ( is_null( $instance ) ) {
|
||||
$instance = new WP_Script_Modules();
|
||||
@@ -28,89 +28,84 @@ function wp_modules() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers the module if no module with that module identifier has already
|
||||
* been registered.
|
||||
* Registers the script module if no script module with that script 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.
|
||||
* @param string $id The identifier of the script module. Should be unique. It will be used in the
|
||||
* final import map.
|
||||
* @param string $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.
|
||||
* @param array $deps {
|
||||
* Optional. List of dependencies.
|
||||
*
|
||||
* @type string|array $0... {
|
||||
* 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.
|
||||
*
|
||||
* @type string $id The script module identifier.
|
||||
* @type string $import Optional. Import type. May be either `static` or
|
||||
* `dynamic`. Defaults to `static`.
|
||||
* }
|
||||
* }
|
||||
* @param string|false|null $version Optional. 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.
|
||||
*/
|
||||
function wp_register_module( $module_id, $src, $deps = array(), $version = false ) {
|
||||
wp_modules()->register( $module_id, $src, $deps, $version );
|
||||
function wp_register_script_module( string $id, string $src, array $deps = array(), $version = false ) {
|
||||
wp_script_modules()->register( $id, $src, $deps, $version );
|
||||
}
|
||||
|
||||
/**
|
||||
* Marks the module to be enqueued in the page.
|
||||
* Marks the script module to be enqueued in the page.
|
||||
*
|
||||
* If a src is provided and the module has not been registered yet, it will be
|
||||
* registered.
|
||||
* If a src is provided and the script 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.
|
||||
* @param string $id The identifier of the script module. Should be unique. It will be used in the
|
||||
* final import map.
|
||||
* @param string $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.
|
||||
* @param array $deps {
|
||||
* Optional. List of dependencies.
|
||||
*
|
||||
* @type string|array $0... {
|
||||
* 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.
|
||||
*
|
||||
* @type string $id The script module identifier.
|
||||
* @type string $import Optional. Import type. May be either `static` or
|
||||
* `dynamic`. Defaults to `static`.
|
||||
* }
|
||||
* }
|
||||
* @param string|false|null $version Optional. 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.
|
||||
*/
|
||||
function wp_enqueue_module( $module_id, $src = '', $deps = array(), $version = false ) {
|
||||
wp_modules()->enqueue( $module_id, $src, $deps, $version );
|
||||
function wp_enqueue_script_module( string $id, string $src = '', array $deps = array(), $version = false ) {
|
||||
wp_script_modules()->enqueue( $id, $src, $deps, $version );
|
||||
}
|
||||
|
||||
/**
|
||||
* Unmarks the module so it is no longer enqueued in the page.
|
||||
* Unmarks the script module so it is no longer enqueued in the page.
|
||||
*
|
||||
* @since 6.5.0
|
||||
*
|
||||
* @param string $module_id The identifier of the module.
|
||||
* @param string $id The identifier of the script module.
|
||||
*/
|
||||
function wp_dequeue_module( $module_id ) {
|
||||
wp_modules()->dequeue( $module_id );
|
||||
function wp_dequeue_script_module( string $id ) {
|
||||
wp_script_modules()->dequeue( $id );
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user