wp_list_pluck() WP 1.0

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.

No Hooks.

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.

Usage

wp_list_pluck( $list, $field, $index_key );

$list(array) (required)

List of objects or arrays

$field(int/string) (required)

Field from the object to place instead of the entire object

$index_key(int/string)

Field from the object to use as keys for the new array.
Default: null

Changelog

Code of wp_list_pluck() wp list pluck ^{WP 5.6}

<?php
function wp_list_pluck( $list, $field, $index_key = null ) {
	$util = new WP_List_Util( $list );
	return $util->pluck( $field, $index_key );
}

Related Functions

From tag: array list help functions (sorting arrays objects)

More from category: Helper Functions