Ticket #54751: 54751.2.diff

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

@@ -144 +144 @@
          *
          * This has the same functionality and prototype of
          * array_column() (PHP 5.5) but also supports objects.
+         * 
+         * Displays a `_doing_it_wrong()` notice when object is not an array.
          *
          * @since 4.7.0
          *
          * @param int|string $field     Field to fetch from the object or array.
          * @param int|string $index_key Optional. Field from the element to use as keys for the new array.
          *                              Default null.
-         * @return array Array of found values. If `$index_key` is set, an array of found values with keys
-         *               corresponding to `$index_key`. If `$index_key` is null, array keys from the original
-         *               `$list` will be preserved in the results.
+         * @return array|WP_Error               Array of found values. If `$index_key` is set, an array of found 
+         *                                                              values with keys corresponding to `$index_key`. If `$index_key` is
+         *                                                              null, array keys from the original `$list` will be preserved in the 
+         *                                                              results on success,
+         *                                                              WP_Error object on failure.
          */
         public function pluck( $field, $index_key = null ) {
+                
+                if ( ! is_array( $this->output ) ) {
+                        /*
+                         * Check if given object is an array.
+                         * Return an error if target is no array.
+                         */
+                        _doing_it_wrong(
+                                __METHOD__,
+                                __( 'Input object must be an array.' ),
+                                '6.0.0'
+                        );
+                        return new WP_Error( 'input_object_is_no_array', __( 'List input object to pluck from must be an array.' ) );
+                }
+
                 $newlist = array();
 
                 if ( ! $index_key ) {

tests/phpunit/tests/functions/wpListUtil.php

@@ -52 +52 @@
                 $this->assertEqualSets( $expected, $actual );
                 $this->assertEqualSets( $expected, $util->get_output() );
         }
+
+        /**
+         * @covers WP_List_Util::pluck
+         */
+        public function test_wp_list_util_pluck() {
+                $expected = array(
+                        0 => 'buz',
+                        1 => 'baz',
+                );
+
+                $util   = new WP_List_Util(
+                        array(
+                                (object) array(
+                                        'foo' => 'bar',
+                                        'bar' => 'buz',
+                                ),
+                                (object) array( 'bar' => 'baz' ),
+                        )
+                );
+                $actual = $util->pluck( 'bar' );
+
+                $this->assertEqualSets( $expected, $actual );
+                $this->assertEqualSets( $expected, $util->get_output() );
+        }
+
+        /**
+         * @covers WP_List_Util::pluck
+         */
+        public function test_wp_list_util_pluck_with_index_key() {
+                $expected = array(
+                        'bar1' => 'buz',
+                        'bar2' => 'baz',
+                );
+
+                $util   = new WP_List_Util(
+                        array(
+                                (object) array(
+                                        'test_key' => 'bar1',
+                                        'test_field' => 'buz',
+                                ),
+                                (object) array( 
+                                        'test_key' => 'bar2',
+                                        'test_field' => 'baz', 
+                                ),
+                        )
+                );
+                $actual = $util->pluck( 'test_field' , 'test_key' );
+
+                $this->assertEqualSets( $expected, $actual );
+                $this->assertEqualSets( $expected, $util->get_output() );
+        }
+
+        /**
+         * Test for doing it wrong on invalid argument, type string.
+         * 
+         * @covers WP_List_Util::pluck
+         * @expectedIncorrectUsage WP_List_Util::pluck
+         * @ticket 54751
+         */
+        public function test_wp_list_util_pluck_doing_it_wrong_when_string_is_given() {
+
+                $this->setExpectedIncorrectUsage( 'WP_List_Util::pluck' );
+
+                $util   = new WP_List_Util(
+                        'invalid'
+                );
+
+                $actual = $util->pluck( 'bar' );
+
+                $this->assertInstanceOf( 'WP_Error', $actual );
+        }
+
+        /**
+         * Test for doing it wrong on invalid argument, type integer.
+         * 
+         * @covers WP_List_Util::pluck
+         * @expectedIncorrectUsage WP_List_Util::pluck
+         * @ticket 54751
+         */
+        public function test_wp_list_util_pluck_doing_it_wrong_when_integer_is_given() {
+
+                $this->setExpectedIncorrectUsage( 'WP_List_Util::pluck' );
+
+                $util   = new WP_List_Util(
+                        15101994
+                );
+
+                $actual = $util->pluck( 'bar' );
+
+                $this->assertInstanceOf( 'WP_Error', $actual );
+        }
 }