wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_list_pluck › WordPress Function

Since3.1.0
Deprecatedn/a
› wp_list_pluck ( $input_list, $field, $index_key = null )
Parameters: (3)
  • (array) $input_list List of objects or arrays.
    Required: Yes
  • (int|string) $field Field from the object to place instead of the entire object.
    Required: Yes
  • (int|string) $index_key Optional. Field from the object to use as keys for the new array. Default null.
    Required: No
    Default: null
Returns:
  • (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 `$input_list` will be preserved in the results.
Defined at:
Codex:
Change Log:
  • 4.0.0
  • 4.7.0

Plucks a certain field out of each object or array in an array.

This has the same functionality and prototype of array_column() (PHP 5.5) but also supports objects.


Related Functions: wp_list_cats, wp_list_pages, wp_set_post_lock, wp_list_users, wp_insert_link

Source 

function wp_list_pluck( $input_list, $field, $index_key = null ) {
	if ( ! is_array( $input_list ) ) {
		return array();
	}

	$util = new WP_List_Util( $input_list );

	return $util->pluck( $field, $index_key );
}