Changeset 31451

Timestamp:

02/13/2015 04:51:55 PM (10 years ago)

Author:

boonebgorges

Message:

Improve documentation for return value of wp_list_pluck().

wp_list_pluck() will preserve the original array keys if no $index_key
parameter is provided. This changeset updates the documentation accordingly.

Props adamsilverstein.
Fixes #31316.

File:

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

trunk/src/wp-includes/functions.php

@@ -3173 +3173 @@
  * @param int|string $index_key Optional. Field from the object 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.
+ * @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.
  */
 function wp_list_pluck( $list, $field, $index_key = null ) {