Changeset 58742 for trunk/src/wp-includes/class-wp-token-map.php

Timestamp:

07/17/2024 12:51:34 AM (9 months ago)

Author:

dmsnell

Message:

Fix phpdoc nullable types in some files.

It was found that in several places in the HTML API and its supporting files,
the wrong form of type annotation was used for optional parameters.

Instead of using ?type, this patch uses type|type-of-default-value instead,
noting where important if the parameter is optional, and if so, what its default
value is.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/7031
Discussed in https://core.trac.wordpress.org/ticket/61399

Props dmsnell, jonsurrell.
See #61399.

File:

• trunk/src/wp-includes/class-wp-token-map.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-token-map.php

@@ -521 +521 @@
      * @since 6.6.0
      *
-     * @param string  $text                       String in which to search for a lookup key.
-     * @param int     $offset                     Optional. How many bytes into the string where the lookup key ought to start. Default 0.
-     * @param ?int    &$matched_token_byte_length Optional. Holds byte-length of found token matched, otherwise not set. Default null.
-     * @param string  $case_sensitivity           Optional. Pass 'ascii-case-insensitive' to ignore ASCII case when matching. Default 'case-sensitive'.
+     * @param string   $text                       String in which to search for a lookup key.
+     * @param int      $offset                     Optional. How many bytes into the string where the lookup key ought to start. Default 0.
+     * @param int|null &$matched_token_byte_length Optional. Holds byte-length of found token matched, otherwise not set. Default null.
+     * @param string   $case_sensitivity           Optional. Pass 'ascii-case-insensitive' to ignore ASCII case when matching. Default 'case-sensitive'.
+     *
      * @return string|null Mapped value of lookup key if found, otherwise `null`.
      */