Changeset 58742 for trunk/src/wp-includes/html-api/class-wp-html-processor.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/html-api/class-wp-html-processor.php (modified) (3 diffs)

trunk/src/wp-includes/html-api/class-wp-html-processor.php

@@ -242 +242 @@
      * @since 6.6.0
      *
-     * @var ?WP_HTML_Stack_Event
+     * @var WP_HTML_Stack_Event|null
      */
     private $current_element = null;
@@ -249 +249 @@
      * Context node if created as a fragment parser.
      *
-     * @var ?WP_HTML_Token
+     * @var WP_HTML_Token|null
      */
     private $context_node = null;
@@ -753 +753 @@
      *       SVG and MathML namespace.
      *
-     * @param  ?WP_HTML_Token $node Node to examine instead of current node, if provided.
-     * @return bool Whether to expect a closer for the currently-matched node,
-     *              or `null` if not matched on any token.
+     * @param WP_HTML_Token|null $node Optional. Node to examine, if provided.
+     *                                 Default is to examine current node.
+     * @return bool|null Whether to expect a closer for the currently-matched node,
+     *                   or `null` if not matched on any token.
      */
     public function expects_closer( $node = null ) {