wp_list_pluck( array $list, int|string $field, int|string $index_key = null )

Pluck a certain field out of each object in a list.

Description

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

Parameters

$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) (Optional) Field from the object to use as keys for the new array.

Default value: null

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.

Source

File: wp-includes/functions.php 

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

Expand Source Code View on GitHub

Related

Used By

Used By
Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_response()

Prepares a single post output for response.
wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php: WP_REST_Post_Types_Controller::prepare_item_for_response()

Prepares a post type object for serialization.
wp-includes/widgets/class-wp-widget-media-video.php: WP_Widget_Media_Video::render_media()

Render the media on the frontend.
wp-includes/widgets/class-wp-widget-media-audio.php: WP_Widget_Media_Audio::render_media()

Render the media on the frontend.
wp-includes/widgets/class-wp-widget-media-gallery.php: WP_Widget_Media_Gallery::render_media()

Render the media on the frontend.
wp-includes/widgets/class-wp-widget-recent-comments.php: WP_Widget_Recent_Comments::widget()

Outputs the content for the current Recent Comments widget instance.
wp-includes/widgets/class-wp-widget-media-image.php: WP_Widget_Media_Image::render_media()

Render the media on the frontend.
wp-includes/widgets/class-wp-widget-media.php: WP_Widget_Media::widget()

Displays the widget on the front-end.
wp-includes/widgets/class-wp-widget-media.php: WP_Widget_Media::form()

Outputs the settings update form.
wp-includes/media.php: wp_enqueue_media()

Enqueues all scripts, styles, settings, and templates necessary to use all media JS APIs.
wp-includes/media.php: get_post_galleries_images()

Retrieve the image srcs from galleries from a post’s content, if present
wp-includes/class-wp-tax-query.php: WP_Tax_Query::transform_query()

Transforms a single query, from one field to another.
wp-includes/class-wp-post.php: WP_Post::__get()

Getter.
wp-includes/category-template.php: get_the_terms()

Retrieve the terms of the taxonomy that are attached to the post.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::import_theme_starter_content()

Import theme starter content into the customized state.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::unsanitized_post_values()

Get dirty pre-sanitized setting values in the current customized state.
wp-includes/class-wp-term-query.php: WP_Term_Query::get_terms()

Get terms, based on query_vars.
wp-includes/class-wp-comment-query.php: WP_Comment_Query::fill_descendants()

Fetch descendants for located comments.
wp-includes/taxonomy.php: is_object_in_term()

Determine if the given object is associated with any of the given terms.
wp-includes/taxonomy.php: wp_delete_term()

Removes a term from the database.
wp-includes/taxonomy.php: wp_insert_term()

Add a new term to the database.
wp-admin/includes/class-wp-media-list-table.php: WP_Media_List_Table::display_rows()
wp-admin/includes/class-wp-comments-list-table.php: WP_Comments_List_Table::prepare_items()
wp-admin/includes/template.php: _media_states()
wp-admin/includes/template.php: get_inline_data()

Adds hidden fields with the data for use in the inline editor for posts and pages.
wp-admin/includes/class-wp-plugin-install-list-table.php: WP_Plugin_Install_List_Table::prepare_items()
wp-admin/includes/class-wp-automatic-updater.php: WP_Automatic_Updater::send_debug_email()

Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
wp-admin/includes/revision.php: wp_prepare_revisions_for_js()

Prepare revisions for JavaScript.
wp-admin/includes/taxonomy.php: get_terms_to_edit()

Get comma-separated list of terms available to edit for the given post ID.
Show 24 more used by Hide more used by

Changelog

Changelog
Version Description
WP-4.7.0 Uses WP_List_Util class.
WP-4.0.0 $index_key parameter added.
WP-3.1.0 Introduced.