wp_parse_list( mixed[]|string $input_list ): array

Parameters

$input_listmixed[]|string

List of values.

Return

array

Array of scalar values. A string is split into a list, while an array keeps its keys, so the result is not necessarily a list.

Used by · 13

• WP_Comment_Query::get_comment_ids()Used internally to get a list of comment IDs matching the query vars.
• WP_REST_Controller::get_fields_for_response()Gets an array of fields to be included on the response.
• WP_REST_Menu_Items_Controller::get_item_schema()Retrieves the nav menu item's schema, conforming to JSON Schema.
• WP_REST_Pattern_Directory_Controller::get_transient_key()Include a hash of the query args, so that different requests are stored in separate caches.
• WP_REST_Server::get_index()Retrieves the site index.
• WP_Theme::get_block_patterns()Gets block pattern data for a specified theme.
• get_pages()Retrieves an array of pages (or hierarchical post type items).
• rest_filter_response_fields()Filters the REST API response to include only an allow-listed set of response object fields.
• rest_is_array()Determines if a given value is array-like.
• rest_parse_embed_param()Parses the "_embed" parameter into the list of resources to embed.
• rest_sanitize_array()Converts an array-like value to an array.
• wp_parse_id_list()Cleans up an array, comma- or space-separated list of IDs.

Source

View on Trac ↗View on GitHub ↗

5041function wp_parse_list( $input_list ): array {5042	if ( ! is_array( $input_list ) ) {5043		$parsed_list = preg_split( '/[\s,]+/', $input_list, -1, PREG_SPLIT_NO_EMPTY );5044		return is_array( $parsed_list ) ? $parsed_list : array();5045	}5046 5047	// Validate all entries of the list are scalar.5048	$input_list = array_filter( $input_list, 'is_scalar' );5049 5050	return $input_list;5051}

History

Introduced in 5.1.0. One change between 6.7.7 and 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 7.1.0 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.