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

Timestamp:

07/19/2024 11:42:14 PM (2 years 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-decoder.php (modified) (5 diffs)

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

@@ -32 +32 @@
          * @return bool Whether the attribute value starts with the given string.
          */
-        public static function attribute_starts_with( $haystack, $search_text, $case_sensitivity = 'case-sensitive' ) {
+        public static function attribute_starts_with( $haystack, $search_text, $case_sensitivity = 'case-sensitive' ): bool {
                 $search_length = strlen( $search_text );
                 $loose_case    = 'ascii-case-insensitive' === $case_sensitivity;
@@ -91 +91 @@
          * @return string Decoded UTF-8 value of given text node.
          */
-        public static function decode_text_node( $text ) {
+        public static function decode_text_node( $text ): string {
                 return static::decode( 'data', $text );
         }
@@ -111 +111 @@
          * @return string Decoded UTF-8 value of given attribute value.
          */
-        public static function decode_attribute( $text ) {
+        public static function decode_attribute( $text ): string {
                 return static::decode( 'attribute', $text );
         }
@@ -134 +134 @@
          * @return string Decoded UTF-8 string.
          */
-        public static function decode( $context, $text ) {
+        public static function decode( $context, $text ): string {
                 $decoded = '';
                 $end     = strlen( $text );
@@ -422 +422 @@
          * @return string Converted code point, or `�` if invalid.
          */
-        public static function code_point_to_utf8_bytes( $code_point ) {
+        public static function code_point_to_utf8_bytes( $code_point ): string {
                 // Pre-check to ensure a valid code point.
                 if (