Skip to content

Commit

Permalink
Use @type instead of detailed array types
Browse files Browse the repository at this point in the history
  • Loading branch information
@luisherranz
luisherranz committed Jan 17, 2024
1 parent 0871981 commit 7d48527
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 110 deletions.
98 changes: 43 additions & 55 deletions src/wp-includes/class-wp-script-modules.php
View file
Expand Up @@ -36,32 +36,27 @@ class WP_Script_Modules {
*
* @since 6.5.0
*
* @param string $id The identifier of the script module.
* Should be unique. It will be used
* in the final import map.
* @param string $src Full URL of the script module, or
* path of the script module relative
* to the WordPress root directory.
* @param array<string|array{id: string, import?: 'static'|'dynamic' }> $deps Optional. 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.
* @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.
* @param string $id The identifier of the script module. Should be unique. It will be used in the
* final import map.
* @param string $src Full URL of the script module, or path of the script module relative to the
* WordPress root directory.
* @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.
*/
public function register( $id, $src, $deps = array(), $version = false ) {
if ( ! isset( $this->registered[ $id ] ) ) {
Expand Down Expand Up @@ -103,35 +98,28 @@ public function register( $id, $src, $deps = array(), $version = false ) {
*
* @since 6.5.0
*
* @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 the WordPress root
* directory. If it is provided and the
* script module has not been registered
* yet, it will be registered.
* @param array<string|array{id: string, import?: 'static'|'dynamic' }> $deps Optional. 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.
* @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.
* @param string $id The identifier of the script module. Should be unique. It will be used in the
* final import map.
* @param string $src Optinal. 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.
*/
public function enqueue( $id, $src = '', $deps = array(), $version = false ) {
if ( isset( $this->registered[ $id ] ) ) {
Expand Down

0 comments on commit 7d48527

Please sign in to comment.