Changeset 55423

Timestamp:

02/25/2023 10:57:14 AM (23 months ago)

Author:

SergeyBiryukov

Message:

General: Add more error checking to WP_List_Util::pluck().

Values for the input array in WP_List_Util::pluck() or wp_list_pluck() must be either objects or arrays.

This commit adds a check to ensure that the value retrieved in the loop is an array before treating it as such, and throws a _doing_it_wrong() notice if it is neither an object nor an array.

Follow-up to [14108], [15686], [18602], [28900], [38928].

Props afragen, costdev, audrasjb.
Fixes #56650.

Location:

trunk

Files:

• src/wp-includes/class-wp-list-util.php (modified) (3 diffs)
• tests/phpunit/tests/functions/wpListUtil.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-list-util.php

@@ -167 +167 @@
                 if ( is_object( $value ) ) {
                     $newlist[ $key ] = $value->$field;
+                } elseif ( is_array( $value ) ) {
+                    $newlist[ $key ] = $value[ $field ];
                 } else {
-                    $newlist[ $key ] = $value[ $field ];
+                    _doing_it_wrong(
+                        __METHOD__,
+                        __( 'Values for the input array must be either objects or arrays.' ),
+                        '6.2.0'
+                    );
                 }
             }
@@ -188 +194 @@
                     $newlist[] = $value->$field;
                 }
-            } else {
+            } elseif ( is_array( $value ) ) {
                 if ( isset( $value[ $index_key ] ) ) {
                     $newlist[ $value[ $index_key ] ] = $value[ $field ];
@@ -194 +200 @@
                     $newlist[] = $value[ $field ];
                 }
+            } else {
+                _doing_it_wrong(
+                    __METHOD__,
+                    __( 'Values for the input array must be either objects or arrays.' ),
+                    '6.2.0'
+                );
             }
         }

trunk/tests/phpunit/tests/functions/wpListUtil.php

@@ -86 +86 @@
 
     /**
-     * Data provider for test_wp_list_util_pluck_simple().
+     * Data provider for test_wp_list_util_pluck().
      *
      * @return array[]
@@ -106 +106 @@
                 'expected'     => array( 'bar' ),
             ),
+        );
+    }
+
+    /**
+     * Tests that wp_list_pluck() throws _doing_it_wrong() with invalid input.
+     *
+     * @ticket 56650
+     *
+     * @dataProvider data_wp_list_pluck_should_throw_doing_it_wrong_with_invalid_input
+     *
+     * @covers WP_List_Util::pluck
+     * @covers ::wp_list_pluck
+     *
+     * @expectedIncorrectUsage WP_List_Util::pluck
+     *
+     * @param array $input An invalid input array.
+     */
+    public function test_wp_list_pluck_should_throw_doing_it_wrong_with_invalid_input( $input ) {
+        $this->assertSame( array(), wp_list_pluck( $input, 'a_field' ) );
+    }
+
+    /**
+     * Tests that wp_list_pluck() throws _doing_it_wrong() with an index key and invalid input.
+     *
+     * @ticket 56650
+     *
+     * @dataProvider data_wp_list_pluck_should_throw_doing_it_wrong_with_invalid_input
+     *
+     * @covers WP_List_Util::pluck
+     * @covers ::wp_list_pluck
+     *
+     * @expectedIncorrectUsage WP_List_Util::pluck
+     *
+     * @param array $input An invalid input array.
+     */
+    public function test_wp_list_pluck_should_throw_doing_it_wrong_with_index_key_and_invalid_input( $input ) {
+        $this->assertSame( array(), wp_list_pluck( $input, 'a_field', 'an_index_key' ) );
+    }
+
+    /**
+     * Data provider that provides invalid input arrays.
+     *
+     * @return array
+     */
+    public function data_wp_list_pluck_should_throw_doing_it_wrong_with_invalid_input() {
+        return array(
+            'int[] 0'                   => array( array( 0 ) ),
+            'int[] 1'                   => array( array( 1 ) ),
+            'int[] -1'                  => array( array( -1 ) ),
+            'float[] 0.0'               => array( array( 0.0 ) ),
+            'float[] 1.0'               => array( array( 1.0 ) ),
+            'float[] -1.0'              => array( array( -1.0 ) ),
+            'string[] and empty string' => array( array( '' ) ),
+            'string[] and "0"'          => array( array( '0' ) ),
+            'string[] and "1"'          => array( array( '1' ) ),
+            'string[] and "-1"'         => array( array( '-1' ) ),
+            'array and null'            => array( array( null ) ),
+            'array and false'           => array( array( false ) ),
+            'array and true'            => array( array( true ) ),
         );
     }