Changeset 58769 for trunk/src/wp-includes/html-api/class-wp-html-stack-event.php

Timestamp:

07/19/2024 11:42:14 PM (12 months ago)

Author:

dmsnell

Message:

HTML API: Add PHP type annotations.

This patch adds type annotations to internal and private methods of the HTML
API and the supporting WP_Token_Map. Annotations have not been added to the
public interfaces where it would likely crash a site if called wrong.

These annotations should help avoid unnecessary type-related bugs (as have
been uncovered in earlier work adding such annotations) and provide additional
guidance to developers when interacting with these classes in an IDE.

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

Props dmsnell, jonsurrell.
See #61399.

File:

• trunk/src/wp-includes/html-api/class-wp-html-stack-event.php (modified) (1 diff)

trunk/src/wp-includes/html-api/class-wp-html-stack-event.php

@@ -75 +75 @@
      * @param string        $provenance "virtual" or "real".
      */
-    public function __construct( $token, $operation, $provenance ) {
+    public function __construct( WP_HTML_Token $token, string $operation, string $provenance ) {
         $this->token      = $token;
         $this->operation  = $operation;