Changeset 58389

Timestamp:

06/11/2024 12:36:13 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Administration: Remove redundant type casting in WP_List_Table::search_box().

Scalar values passed to esc_attr() are already converted internally to a string via both wp_check_invalid_utf8() and _wp_specialchars().

Includes adding @covers tags for unit tests.

Follow-up to [58379].

See #58379.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-list-table.php (modified) (1 diff)
• tests/phpunit/tests/admin/wpListTable.php (modified) (5 diffs)

trunk/src/wp-admin/includes/class-wp-list-table.php

@@ -391 +391 @@
                         if ( is_array( $_REQUEST['orderby'] ) ) {
                                 foreach ( $_REQUEST['orderby'] as $key => $value ) {
-                                        /*
-                                         * Orderby can be either an associative array or non-associative array.
-                                         * In the latter case, this makes sure the key is a string before calling esc_attr().
-                                         */
-                                        $key = (string) $key;
                                         echo '<input type="hidden" name="orderby[' . esc_attr( $key ) . ']" value="' . esc_attr( $value ) . '" />';
                                 }

trunk/tests/phpunit/tests/admin/wpListTable.php

@@ -142 +142 @@
 
         /**
-         * Tests the "get_views_links()" method.
+         * Tests the `WP_List_Table::get_views_links()` method.
          *
          * @ticket 42066
@@ -256 +256 @@
 
         /**
-         * Tests that "get_views_links()" throws a _doing_it_wrong().
+         * Tests that `WP_List_Table::get_views_links()` throws a `_doing_it_wrong()`.
          *
          * @ticket 42066
@@ -524 +524 @@
 
         /**
-         * Tests that "search_box()" works correctly with an orderby array with multiple values.
+         * Tests that `WP_List_Table::search_box()` works correctly with an `orderby` array with multiple values.
          *
          * @ticket 59494
+         *
+         * @covers WP_List_Table::search_box()
          */
         public function test_search_box_working_with_array_of_orderby_multiple_values() {
@@ -545 +547 @@
 
         /**
-         * Tests that "search_box()" works correctly with an orderby array with a single value.
+         * Tests that `WP_List_Table::search_box()` works correctly with an `orderby` array with a single value.
          *
          * @ticket 59494
+         *
+         * @covers WP_List_Table::search_box()
          */
         public function test_search_box_working_with_array_of_orderby_single_value() {
@@ -564 +568 @@
 
         /**
-         * Tests that "search_box()" works correctly with orderby set to a string.
+         * Tests that `WP_List_Table::search_box()` works correctly with `orderby` set to a string.
          *
          * @ticket 59494
+         *
+         * @covers WP_List_Table::search_box()
          */
         public function test_search_box_works_with_orderby_string() {