Changeset 28900

Timestamp:

06/29/2014 09:25:21 PM (10 years ago)

Author:

nacin

Message:

Add index key support for wp_list_pluck(), à la array_column().

props trepmal.
fixes #28666.

Location:

trunk

Files:

• src/wp-includes/functions.php (modified) (1 diff)
• tests/phpunit/tests/functions/listFilter.php (modified) (2 diffs)

trunk/src/wp-includes/functions.php

@@ -2883 +2883 @@
  * Pluck a certain field out of each object in a list.
  *
+ * This has the same functionality and prototype of
+ * array_column() (PHP 5.5) but also supports objects.
+ *
  * @since 3.1.0
  *
  * @param array $list A list of objects or arrays
  * @param int|string $field A field from the object to place instead of the entire object
+ * @param int|string $index_key A field from the object to use as keys for the new array
  * @return array
  */
-function wp_list_pluck( $list, $field ) {
-    foreach ( $list as $key => $value ) {
-        if ( is_object( $value ) )
-            $list[ $key ] = $value->$field;
-        else
-            $list[ $key ] = $value[ $field ];
-    }
-
-    return $list;
+function wp_list_pluck( $list, $field, $index_key = null ) {
+    if ( ! $index_key ) {
+        // This is simple. Could at some point wrap array_column()
+        // if we knew we had an array of arrays.
+        foreach ( $list as $key => $value ) {
+            if ( is_object( $value ) ) {
+                $list[ $key ] = $value->$field;
+            } else {
+                $list[ $key ] = $value[ $field ];
+            }
+        }
+        return $list;
+    }
+
+    // When index_key is not set for a particular item,
+    // push the value to the end of the stack.
+    // This is how array_column() behaves.
+    $newlist = array();
+    foreach ( $list as $value ) {
+        if ( is_object( $value ) ) {
+            if ( isset( $value->$index_key ) ) {
+                $newlist[ $value->$index_key ] = $value->$field;
+            } else {
+                $newlist[] = $value->$field;
+            }
+        } else {
+            if ( isset( $value[ $index_key ] ) ) {
+                $newlist[ $value[ $index_key ] ] = $value[ $field ];
+            } else {
+                $newlist[] = $value[ $field ];
+            }
+        }
+    }
+
+    return $newlist;
 }
 

trunk/tests/phpunit/tests/functions/listFilter.php

@@ -12 +12 @@
     function setUp() {
         parent::setUp();
-        $this->array_list['foo'] = array( 'name' => 'foo', 'field1' => true, 'field2' => true, 'field3' => true, 'field4' => array( 'red' ) );
-        $this->array_list['bar'] = array( 'name' => 'bar', 'field1' => true, 'field2' => true, 'field3' => false, 'field4' => array( 'green' ) );
-        $this->array_list['baz'] = array( 'name' => 'baz', 'field1' => true, 'field2' => false, 'field3' => false, 'field4' => array( 'blue' ) );
+        $this->array_list['foo'] = array( 'name' => 'foo', 'id' => 'f', 'field1' => true, 'field2' => true, 'field3' => true, 'field4' => array( 'red' ) );
+        $this->array_list['bar'] = array( 'name' => 'bar', 'id' => 'b', 'field1' => true, 'field2' => true, 'field3' => false, 'field4' => array( 'green' ) );
+        $this->array_list['baz'] = array( 'name' => 'baz', 'id' => 'z', 'field1' => true, 'field2' => false, 'field3' => false, 'field4' => array( 'blue' ) );
         foreach ( $this->array_list as $key => $value ) {
             $this->object_list[ $key ] = (object) $value;
@@ -67 +67 @@
     }
 
+    /**
+     * @ticket 28666
+     */
+    function test_wp_list_pluck_index_key() {
+        $list = wp_list_pluck( $this->array_list, 'name', 'id' );
+        $this->assertEquals( array( 'f' => 'foo', 'b' => 'bar', 'z' => 'baz' ), $list );
+    }
+
+    /**
+     * @ticket 28666
+     */
+    function test_wp_list_pluck_object_index_key() {
+        $list = wp_list_pluck( $this->object_list, 'name', 'id' );
+        $this->assertEquals( array( 'f' => 'foo', 'b' => 'bar', 'z' => 'baz' ), $list );
+    }
+
+    /**
+     * @ticket 28666
+     */
+    function test_wp_list_pluck_missing_index_key() {
+        $list = wp_list_pluck( $this->array_list, 'name', 'nonexistent' );
+        $this->assertEquals( array( 0 => 'foo', 1 => 'bar', 2 => 'baz' ), $list );
+    }
+
+    /**
+     * @ticket 28666
+     */
+    function test_wp_list_pluck_partial_missing_index_key() {
+        $array_list = $this->array_list;
+        unset( $array_list[ 'bar']['id'] );
+        $list = wp_list_pluck( $array_list, 'name', 'id' );
+        $this->assertEquals( array( 'f' => 'foo', 0 => 'bar', 'z' => 'baz' ), $list );
+    }
+
+    /**
+     * @ticket 28666
+     */
+    function test_wp_list_pluck_mixed_index_key() {
+        $mixed_list = $this->array_list;
+        $mixed_list['bar'] = (object) $mixed_list['bar'];
+        $list = wp_list_pluck( $mixed_list, 'name', 'id' );
+        $this->assertEquals( array( 'f' => 'foo', 'b' => 'bar', 'z' => 'baz' ), $list );
+    }
+
     function test_filter_object_list_nested_array_and() {
         $list = wp_filter_object_list( $this->object_list, array( 'field4' => array( 'blue' ) ), 'AND' );