Skip to content

Commit bad42d3

Browse files
committed
Apply same phpdoc changes to functions in scripts-modules.php
1 parent 8a468d2 commit bad42d3

File tree

1 file changed

+50
-50
lines changed

1 file changed

+50
-50
lines changed

src/wp-includes/script-modules.php

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -37,31 +37,31 @@ function wp_script_modules(): WP_Script_Modules {
3737
* @since 6.5.0
3838
* @since 6.9.0 Added the $args parameter.
3939
*
40-
* @param string $id The identifier of the script module. Should be unique. It will be used in the
41-
* final import map.
42-
* @param string $src Optional. Full URL of the script module, or path of the script module relative
43-
* to the WordPress root directory. If it is provided and the script module has
44-
* not been registered yet, it will be registered.
45-
* @param array $deps {
46-
* Optional. List of dependencies.
47-
*
48-
* @type string|array ...$0 {
49-
* An array of script module identifiers of the dependencies of this script
50-
* module. The dependencies can be strings or arrays. If they are arrays,
51-
* they need an `id` key with the script module identifier, and can contain
52-
* an `import` key with either `static` or `dynamic`. By default,
53-
* dependencies that don't contain an `import` key are considered static.
54-
*
55-
* @type string $id The script module identifier.
56-
* @type string $import Optional. Import type. May be either `static` or
57-
* `dynamic`. Defaults to `static`.
58-
* }
59-
* }
60-
* @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.
61-
* It is added to the URL as a query string for cache busting purposes. If $version
62-
* is set to false, the version number is the currently installed WordPress version.
63-
* If $version is set to null, no version is added.
64-
* @param array $args {
40+
* @param string $id The identifier of the script module. Should be unique. It will be used in the
41+
* final import map.
42+
* @param string $src Optional. Full URL of the script module, or path of the script module relative
43+
* to the WordPress root directory. If it is provided and the script module has
44+
* not been registered yet, it will be registered.
45+
* @param array<string|array> $deps {
46+
* Optional. List of dependencies.
47+
*
48+
* @type string|array ...$0 {
49+
* An array of script module identifiers of the dependencies of this script
50+
* module. The dependencies can be strings or arrays. If they are arrays,
51+
* they need an `id` key with the script module identifier, and can contain
52+
* an `import` key with either `static` or `dynamic`. By default,
53+
* dependencies that don't contain an `import` key are considered static.
54+
*
55+
* @type string $id The script module identifier.
56+
* @type string $import Optional. Import type. May be either `static` or
57+
* `dynamic`. Defaults to `static`.
58+
* }
59+
* }
60+
* @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.
61+
* It is added to the URL as a query string for cache busting purposes. If $version
62+
* is set to false, the version number is the currently installed WordPress version.
63+
* If $version is set to null, no version is added.
64+
* @param array<string, string|bool> $args {
6565
* Optional. An array of additional args. Default empty array.
6666
*
6767
* @type bool $in_footer Whether to print the script module in the footer. Only relevant to block themes. Default 'false'. Optional.
@@ -81,31 +81,31 @@ function wp_register_script_module( string $id, string $src, array $deps = array
8181
* @since 6.5.0
8282
* @since 6.9.0 Added the $args parameter.
8383
*
84-
* @param string $id The identifier of the script module. Should be unique. It will be used in the
85-
* final import map.
86-
* @param string $src Optional. Full URL of the script module, or path of the script module relative
87-
* to the WordPress root directory. If it is provided and the script module has
88-
* not been registered yet, it will be registered.
89-
* @param array $deps {
90-
* Optional. List of dependencies.
91-
*
92-
* @type string|array ...$0 {
93-
* An array of script module identifiers of the dependencies of this script
94-
* module. The dependencies can be strings or arrays. If they are arrays,
95-
* they need an `id` key with the script module identifier, and can contain
96-
* an `import` key with either `static` or `dynamic`. By default,
97-
* dependencies that don't contain an `import` key are considered static.
98-
*
99-
* @type string $id The script module identifier.
100-
* @type string $import Optional. Import type. May be either `static` or
101-
* `dynamic`. Defaults to `static`.
102-
* }
103-
* }
104-
* @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.
105-
* It is added to the URL as a query string for cache busting purposes. If $version
106-
* is set to false, the version number is the currently installed WordPress version.
107-
* If $version is set to null, no version is added.
108-
* @param array $args {
84+
* @param string $id The identifier of the script module. Should be unique. It will be used in the
85+
* final import map.
86+
* @param string $src Optional. Full URL of the script module, or path of the script module relative
87+
* to the WordPress root directory. If it is provided and the script module has
88+
* not been registered yet, it will be registered.
89+
* @param array<string|array> $deps {
90+
* Optional. List of dependencies.
91+
*
92+
* @type string|array ...$0 {
93+
* An array of script module identifiers of the dependencies of this script
94+
* module. The dependencies can be strings or arrays. If they are arrays,
95+
* they need an `id` key with the script module identifier, and can contain
96+
* an `import` key with either `static` or `dynamic`. By default,
97+
* dependencies that don't contain an `import` key are considered static.
98+
*
99+
* @type string $id The script module identifier.
100+
* @type string $import Optional. Import type. May be either `static` or
101+
* `dynamic`. Defaults to `static`.
102+
* }
103+
* }
104+
* @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.
105+
* It is added to the URL as a query string for cache busting purposes. If $version
106+
* is set to false, the version number is the currently installed WordPress version.
107+
* If $version is set to null, no version is added.
108+
* @param array<string, string|bool> $args {
109109
* Optional. An array of additional args. Default empty array.
110110
*
111111
* @type bool $in_footer Whether to print the script module in the footer. Only relevant to block themes. Default 'false'. Optional.

0 commit comments

Comments
 (0)