Changeset 61358

Timestamp:

12/07/2025 04:14:08 AM (2 months ago)

Author:

westonruter

Message:

Docs: Improve accuracy for types in phpdoc for WP_Dependencies, _WP_Dependency, WP_Scripts, and WP_Styles.

This increases these classes to PHPStan level 8.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10607

See #64238.

Location:

trunk/src/wp-includes

Files:

• class-wp-dependencies.php (modified) (2 diffs)
• class-wp-dependency.php (modified) (2 diffs)
• class-wp-scripts.php (modified) (4 diffs)
• class-wp-styles.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-dependencies.php

@@ -57 +57 @@
      * An array of additional arguments passed when a handle is registered.
      *
-     * Arguments are appended to the item query string.
+     * The keys are dependency handles and the values are query strings which are appended to the item URL's query
+     * string, after the `ver` if provided.
      *
      * @since 2.6.0
      *
-     * @var array
+     * @var array<string, string>
      */
     public $args = array();
@@ -101 +102 @@
      * @since 5.9.0
      *
-     * @var array
+     * @var array<string, string|null>
      */
     private $queued_before_register = array();

trunk/src/wp-includes/class-wp-dependency.php

@@ -67 +67 @@
      *
      * @since 2.6.0
-     * @var array
+     * @var array<string, mixed>
      */
     public $extra = array();
@@ -83 +83 @@
      *
      * @since 5.0.0
-     * @var string
+     * @var string|null
      */
     public $translations_path;

trunk/src/wp-includes/class-wp-scripts.php

@@ -47 +47 @@
      *
      * @since 2.8.0
-     * @var array
+     * @var string[]
      */
     public $in_footer = array();
@@ -119 +119 @@
      *
      * @since 2.8.0
-     * @var array
+     * @var string[]|null
      */
     public $default_dirs;
@@ -375 +375 @@
 
             if (
-                $this->in_default_dir( $filtered_src )
+                is_string( $filtered_src )
+                && $this->in_default_dir( $filtered_src )
                 && ( $before_script || $after_script || $translations_stop_concat || $this->is_delayed_strategy( $strategy ) )
             ) {
@@ -590 +591 @@
      * @since 2.1.0
      *
-     * @param string $handle      Name of the script to attach data to.
-     * @param string $object_name Name of the variable that will contain the data.
-     * @param array  $l10n        Array of data to localize.
+     * @param string               $handle      Name of the script to attach data to.
+     * @param string               $object_name Name of the variable that will contain the data.
+     * @param array<string, mixed> $l10n        Array of data to localize.
      * @return bool True on success, false on failure.
      */

trunk/src/wp-includes/class-wp-styles.php

@@ -97 +97 @@
      *
      * @since 2.8.0
-     * @var array
+     * @var string[]|null
      */
     public $default_dirs;
@@ -184 +184 @@
 
         if ( $this->do_concat ) {
-            if ( $this->in_default_dir( $src ) && ! isset( $obj->extra['alt'] ) ) {
+            if ( is_string( $src ) && $this->in_default_dir( $src ) && ! isset( $obj->extra['alt'] ) ) {
                 $this->concat         .= "$handle,";
                 $this->concat_version .= "$handle$ver";