Make WordPress Core


Ignore:
Timestamp:
01/23/2024 03:32:03 AM (6 months ago)
Author:
dmsnell
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/script-modules.php

    r57269 r57327  
    11<?php
    22/**
    3  * Script Modules API: Module functions
     3 * Script Modules API: Script Module functions
    44 *
    55 * @since 6.5.0
     
    1919 * @return WP_Script_Modules The main WP_Script_Modules instance.
    2020 */
    21 function wp_modules() {
     21function wp_script_modules(): WP_Script_Modules {
    2222    static $instance = null;
    2323    if ( is_null( $instance ) ) {
     
    2929
    3030/**
    31  * Registers the module if no module with that module identifier has already
    32  * been registered.
     31 * Registers the script module if no script module with that script module
     32 * identifier has already been registered.
    3333 *
    3434 * @since 6.5.0
    3535 *
    36  * @param string                                                        $module_id The identifier of the module.
    37  *                                                                                 Should be unique. It will be used
    38  *                                                                                 in the final import map.
    39  * @param string                                                        $src       Full URL of the module, or path of
    40  *                                                                                 the module relative to the
    41  *                                                                                 WordPress root directory.
    42  * @param array<string|array{id: string, import?: 'static'|'dynamic' }> $deps      Optional. An array of module
    43  *                                                                                 identifiers of the dependencies of
    44  *                                                                                 this module. The dependencies can
    45  *                                                                                 be strings or arrays. If they are
    46  *                                                                                 arrays, they need an `id` key with
    47  *                                                                                 the module identifier, and can
    48  *                                                                                 contain an `import` key with either
    49  *                                                                                 `static` or `dynamic`. By default,
    50  *                                                                                 dependencies that don't contain an
    51  *                                                                                 `import` key are considered static.
    52  * @param string|false|null                                             $version   Optional. String specifying the
    53  *                                                                                 module version number. Defaults to
    54  *                                                                                 false. It is added to the URL as a
    55  *                                                                                 query string for cache busting
    56  *                                                                                 purposes. If $version is set to
    57  *                                                                                 false, the version number is the
    58  *                                                                                 currently installed WordPress
    59  *                                                                                 version. If $version is set to
    60  *                                                                                 null, no version is added.
     36 * @param string            $id       The identifier of the script module. Should be unique. It will be used in the
     37 *                                    final import map.
     38 * @param string            $src      Optional. Full URL of the script module, or path of the script module relative
     39 *                                    to the WordPress root directory. If it is provided and the script module has
     40 *                                    not been registered yet, it will be registered.
     41 * @param array             $deps     {
     42 *                                        Optional. List of dependencies.
     43 *
     44 *                                        @type string|array $0... {
     45 *                                            An array of script module identifiers of the dependencies of this script
     46 *                                            module. The dependencies can be strings or arrays. If they are arrays,
     47 *                                            they need an `id` key with the script module identifier, and can contain
     48 *                                            an `import` key with either `static` or `dynamic`. By default,
     49 *                                            dependencies that don't contain an `import` key are considered static.
     50 *
     51 *                                            @type string $id     The script module identifier.
     52 *                                            @type string $import Optional. Import type. May be either `static` or
     53 *                                                                 `dynamic`. Defaults to `static`.
     54 *                                        }
     55 *                                    }
     56 * @param string|false|null $version  Optional. String specifying the script module version number. Defaults to false.
     57 *                                    It is added to the URL as a query string for cache busting purposes. If $version
     58 *                                    is set to false, the version number is the currently installed WordPress version.
     59 *                                    If $version is set to null, no version is added.
    6160 */
    62 function wp_register_module( $module_id, $src, $deps = array(), $version = false ) {
    63     wp_modules()->register( $module_id, $src, $deps, $version );
     61function wp_register_script_module( string $id, string $src, array $deps = array(), $version = false ) {
     62    wp_script_modules()->register( $id, $src, $deps, $version );
    6463}
    6564
    6665/**
    67  * Marks the module to be enqueued in the page.
     66 * Marks the script module to be enqueued in the page.
    6867 *
    69  * If a src is provided and the module has not been registered yet, it will be
    70  * registered.
     68 * If a src is provided and the script module has not been registered yet, it
     69 * will be registered.
    7170 *
    7271 * @since 6.5.0
    7372 *
    74  * @param string                                                        $module_id The identifier of the module.
    75  *                                                                                 Should be unique. It will be used
    76  *                                                                                 in the final import map.
    77  * @param string                                                        $src       Optional. Full URL of the module,
    78  *                                                                                 or path of the module relative to
    79  *                                                                                 the WordPress root directory. If
    80  *                                                                                 it is provided and the module has
    81  *                                                                                 not been registered yet, it will be
    82  *                                                                                 registered.
    83  * @param array<string|array{id: string, import?: 'static'|'dynamic' }> $deps      Optional. An array of module
    84  *                                                                                 identifiers of the dependencies of
    85  *                                                                                 this module. The dependencies can
    86  *                                                                                 be strings or arrays. If they are
    87  *                                                                                 arrays, they need an `id` key with
    88  *                                                                                 the module identifier, and can
    89  *                                                                                 contain an `import` key with either
    90  *                                                                                 `static` or `dynamic`. By default,
    91  *                                                                                 dependencies that don't contain an
    92  *                                                                                 `import` key are considered static.
    93  * @param string|false|null                                             $version   Optional. String specifying the
    94  *                                                                                 module version number. Defaults to
    95  *                                                                                 false. It is added to the URL as a
    96  *                                                                                 query string for cache busting
    97  *                                                                                 purposes. If $version is set to
    98  *                                                                                 false, the version number is the
    99  *                                                                                 currently installed WordPress
    100  *                                                                                 version. If $version is set to
    101  *                                                                                 null, no version is added.
     73 * @param string            $id       The identifier of the script module. Should be unique. It will be used in the
     74 *                                    final import map.
     75 * @param string            $src      Optional. Full URL of the script module, or path of the script module relative
     76 *                                    to the WordPress root directory. If it is provided and the script module has
     77 *                                    not been registered yet, it will be registered.
     78 * @param array             $deps     {
     79 *                                        Optional. List of dependencies.
     80 *
     81 *                                        @type string|array $0... {
     82 *                                            An array of script module identifiers of the dependencies of this script
     83 *                                            module. The dependencies can be strings or arrays. If they are arrays,
     84 *                                            they need an `id` key with the script module identifier, and can contain
     85 *                                            an `import` key with either `static` or `dynamic`. By default,
     86 *                                            dependencies that don't contain an `import` key are considered static.
     87 *
     88 *                                            @type string $id     The script module identifier.
     89 *                                            @type string $import Optional. Import type. May be either `static` or
     90 *                                                                 `dynamic`. Defaults to `static`.
     91 *                                        }
     92 *                                    }
     93 * @param string|false|null $version  Optional. String specifying the script module version number. Defaults to false.
     94 *                                    It is added to the URL as a query string for cache busting purposes. If $version
     95 *                                    is set to false, the version number is the currently installed WordPress version.
     96 *                                    If $version is set to null, no version is added.
    10297 */
    103 function wp_enqueue_module( $module_id, $src = '', $deps = array(), $version = false ) {
    104     wp_modules()->enqueue( $module_id, $src, $deps, $version );
     98function wp_enqueue_script_module( string $id, string $src = '', array $deps = array(), $version = false ) {
     99    wp_script_modules()->enqueue( $id, $src, $deps, $version );
    105100}
    106101
    107102/**
    108  * Unmarks the module so it is no longer enqueued in the page.
     103 * Unmarks the script module so it is no longer enqueued in the page.
    109104 *
    110105 * @since 6.5.0
    111106 *
    112  * @param string $module_id The identifier of the module.
     107 * @param string $id The identifier of the script module.
    113108 */
    114 function wp_dequeue_module( $module_id ) {
    115     wp_modules()->dequeue( $module_id );
     109function wp_dequeue_script_module( string $id ) {
     110    wp_script_modules()->dequeue( $id );
    116111}
Note: See TracChangeset for help on using the changeset viewer.