Changeset 28900 for trunk/src/wp-includes/functions.php

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.

File:

• trunk/src/wp-includes/functions.php (modified) (1 diff)

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;
 }