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

Description

Parameters

$input_listarray

List of objects or arrays.

$fieldint|string

Field from the object to place instead of the entire object.

$index_keyint|stringoptional

Field from the object to use as keys for the new array. Default null.Default: 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 $input_list will be preserved in the results.

Uses · 1

• WP_List_Util::__construct()Constructor.

Used by · 44

• 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_Comment_Query::fill_descendants()Fetch descendants for located comments.
• WP_Comments_List_Table::prepare_items()
• WP_Community_Events::trim_events()Prepares the event list for presentation.
• WP_Customize_Manager::import_theme_starter_content()Imports theme starter content into the customized state.
• WP_Customize_Manager::unsanitized_post_values()Gets dirty pre-sanitized setting values in the current customized state.
• WP_Media_List_Table::display_rows()Generates the list table rows.
• WP_Plugin_Install_List_Table::prepare_items()
• WP_Post::__get()Getter.
• WP_Query::get_posts()Retrieves an array of posts based on query variables.
• WP_REST_Menu_Items_Controller::prepare_item_for_response()Prepares a single nav menu item output for response.
• WP_REST_Post_Search_Handler::search_items()Searches posts for a given search request.

Source

View on Trac ↗View on GitHub ↗

5383function wp_list_pluck( $input_list, $field, $index_key = null ) {5384	if ( ! is_array( $input_list ) ) {5385		return array();5386	}5387 5388	$util = new WP_List_Util( $input_list );5389 5390	return $util->pluck( $field, $index_key );5391}

History

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.