Changeset 61402

Timestamp:

12/22/2025 08:43:17 PM (5 months ago)

Author:

westonruter

Message:

Docs: Improve specificity of PHP types in functions.wp-scripts.php and functions.wp-styles.php.

These files now adhere to PHPStan level 8.

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

Follow-up to [61362], [61358].

See #64238.

Location:

trunk/src/wp-includes

Files:

• functions.wp-scripts.php (modified) (4 diffs)
• functions.wp-styles.php (modified) (2 diffs)

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

@@ -142 +142 @@
             '4.5.0'
         );
-        $data = trim( preg_replace( '#<script[^>]*>(.*)</script>#is', '$1', $data ) );
+        $data = trim( (string) preg_replace( '#<script[^>]*>(.*)</script>#is', '$1', $data ) );
     }
 
@@ -161 +161 @@
  * @since 6.9.0 The $fetchpriority parameter of type string was added to the $args parameter of type array.
  *
- * @param string           $handle    Name of the script. Should be unique.
- * @param string|false     $src       Full URL of the script, or path of the script relative to the WordPress root directory.
- *                                    If source is set to false, script is an alias of other scripts it depends on.
- * @param string[]         $deps      Optional. An array of registered script handles this script depends on. Default empty array.
- * @param string|bool|null $ver       Optional. String specifying script version number, if it has one, which is added to the URL
- *                                    as a query string for cache busting purposes. If version is set to false, a version
- *                                    number is automatically added equal to current installed WordPress version.
- *                                    If set to null, no version is added.
- * @param array|bool       $args     {
+ * @param string                          $handle Name of the script. Should be unique.
+ * @param string|false                    $src    Full URL of the script, or path of the script relative to the WordPress root directory.
+ *                                                If source is set to false, script is an alias of other scripts it depends on.
+ * @param string[]                        $deps   Optional. An array of registered script handles this script depends on. Default empty array.
+ * @param string|bool|null                $ver    Optional. String specifying script version number, if it has one, which is added to the URL
+ *                                                as a query string for cache busting purposes. If version is set to false, a version
+ *                                                number is automatically added equal to current installed WordPress version.
+ *                                                If set to null, no version is added.
+ * @param array<string, string|bool>|bool $args   {
  *     Optional. An array of additional script loading strategies. Default empty array.
  *     Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.
@@ -222 +222 @@
  * @todo Documentation cleanup
  *
- * @param string $handle      Script handle the data will be attached to.
- * @param string $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
- *                            Example: '/[a-zA-Z0-9_]+/'.
- * @param array  $l10n        The data itself. The data can be either a single or multi-dimensional array.
+ * @param string               $handle      Script handle the data will be attached to.
+ * @param string               $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
+ *                                          Example: '/[a-zA-Z0-9_]+/'.
+ * @param array<string, mixed> $l10n        The data itself. The data can be either a single or multi-dimensional array.
  * @return bool True if the script was successfully localized, false otherwise.
  */
@@ -347 +347 @@
  * @since 6.9.0 The $fetchpriority parameter of type string was added to the $args parameter of type array.
  *
- * @param string           $handle    Name of the script. Should be unique.
- * @param string           $src       Full URL of the script, or path of the script relative to the WordPress root directory.
- *                                    Default empty.
- * @param string[]         $deps      Optional. An array of registered script handles this script depends on. Default empty array.
- * @param string|bool|null $ver       Optional. String specifying script version number, if it has one, which is added to the URL
- *                                    as a query string for cache busting purposes. If version is set to false, a version
- *                                    number is automatically added equal to current installed WordPress version.
- *                                    If set to null, no version is added.
- * @param array|bool       $args     {
+ * @param string                          $handle Name of the script. Should be unique.
+ * @param string                          $src    Full URL of the script, or path of the script relative to the WordPress root directory.
+ *                                                Default empty.
+ * @param string[]                        $deps   Optional. An array of registered script handles this script depends on. Default empty array.
+ * @param string|bool|null                $ver    Optional. String specifying script version number, if it has one, which is added to the URL
+ *                                                as a query string for cache busting purposes. If version is set to false, a version
+ *                                                number is automatically added equal to current installed WordPress version.
+ *                                                If set to null, no version is added.
+ * @param array<string, string|bool>|bool $args   {
  *     Optional. An array of additional script loading strategies. Default empty array.
  *     Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.

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

@@ -39 +39 @@
  * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
  *
- * @param string|bool|array $handles Styles to be printed. Default 'false'.
+ * @param string|false|string[] $handles Styles to be printed. Default 'false'.
  * @return string[] On success, an array of handles of processed WP_Dependencies items; otherwise, an empty array.
  */
@@ -99 +99 @@
             '3.7.0'
         );
-        $data = trim( preg_replace( '#<style[^>]*>(.*)</style>#is', '$1', $data ) );
+        $data = trim( (string) preg_replace( '#<style[^>]*>(.*)</style>#is', '$1', $data ) );
     }