Changeset 56363 for trunk/src/wp-includes/html-api/class-wp-html-open-elements.php

Timestamp:

08/07/2023 01:48:55 PM (20 months ago)

Author:

Bernhard Reiter

Message:

HTML API: Adjust code styling to Gutenberg's linter's preferences.

Adjust the code style according to the rules that the linting process in Gutenberg requires.

There are only a couple code changes that should have no effect on the runtime:

• A missing check to verify that only UTF-8 is supported has been added (brought up because it was identified as an undefined variable).
• A few return false; statements have been added to avoid having the linter complain that functions don't return a value despite indicating they return bool. The functions are stubs for coming support and currently throw, so the return statements are unreachable.

Props dmsnell, costdev, davidbaumwald, peterwilsoncc, SergeyBiryukov.
Fixes #58918.

File:

• trunk/src/wp-includes/html-api/class-wp-html-open-elements.php (modified) (9 diffs)

trunk/src/wp-includes/html-api/class-wp-html-open-elements.php

@@ -111 +111 @@
      * @return bool Whether the element was found in a specific scope.
      */
-    public function has_element_in_specific_scope( $tag_name, $termination_list ) {
+    public function has_element_in_specific_scope( $tag_name, $termination_list ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
         foreach ( $this->walk_up() as $node ) {
             if ( $node->node_name === $tag_name ) {
@@ -135 +135 @@
             $tag_name,
             array(
+
                 /*
                  * Because it's not currently possible to encounter
@@ -153 +154 @@
      * @see https://html.spec.whatwg.org/#has-an-element-in-list-item-scope
      *
+     * @throws WP_HTML_Unsupported_Exception Always until this function is implemented.
+     *
      * @param string $tag_name Name of tag to check.
      * @return bool Whether given element is in scope.
      */
-    public function has_element_in_list_item_scope( $tag_name ) {
+    public function has_element_in_list_item_scope( $tag_name ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
         throw new WP_HTML_Unsupported_Exception( 'Cannot process elements depending on list item scope.' );
+
+        return false; // The linter requires this unreachable code until the function is implemented and can return.
     }
 
@@ -174 +179 @@
             $tag_name,
             array(
+
                 /*
                  * Because it's not currently possible to encounter
@@ -192 +198 @@
      * @see https://html.spec.whatwg.org/#has-an-element-in-table-scope
      *
+     * @throws WP_HTML_Unsupported_Exception Always until this function is implemented.
+     *
      * @param string $tag_name Name of tag to check.
      * @return bool Whether given element is in scope.
      */
-    public function has_element_in_table_scope( $tag_name ) {
+    public function has_element_in_table_scope( $tag_name ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
         throw new WP_HTML_Unsupported_Exception( 'Cannot process elements depending on table scope.' );
+
+        return false; // The linter requires this unreachable code until the function is implemented and can return.
     }
 
@@ -205 +215 @@
      *
      * @see https://html.spec.whatwg.org/#has-an-element-in-select-scope
+     *
+     * @throws WP_HTML_Unsupported_Exception Always until this function is implemented.
      *
      * @param string $tag_name Name of tag to check.
      * @return bool Whether given element is in scope.
      */
-    public function has_element_in_select_scope( $tag_name ) {
+    public function has_element_in_select_scope( $tag_name ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
         throw new WP_HTML_Unsupported_Exception( 'Cannot process elements depending on select scope.' );
+
+        return false; // The linter requires this unreachable code until the function is implemented and can return.
     }
 
@@ -220 +234 @@
      * @see https://html.spec.whatwg.org/#has-an-element-in-button-scope
      *
-     * @return bool
+     * @return bool Whether a P is in BUTTON scope.
      */
     public function has_p_in_button_scope() {
@@ -321 +335 @@
      *
      * To start with the most-recently added element and walk towards the top,
-     * @see WP_HTML_Open_Elements::walk_up
+     * see WP_HTML_Open_Elements::walk_up().
      *
      * @since 6.4.0
@@ -348 +362 @@
      *
      * To start with the first added element and walk towards the bottom,
-     * @see WP_HTML_Open_Elements::walk_down
+     * see WP_HTML_Open_Elements::walk_down().
      *
      * @since 6.4.0