wp_parse_list( array|string $input_list ): array
- Since
- 5.1.0
- Source
wp-includes/functions.php:4974
Compatibility
- WordPress
- since 5.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$input_listarray|string- List of values.
Return value
array- Array of values.
Performance profile
How much work a call to wp_parse_list() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 9–10
- Plugin surface
- None
- Called by
- 13
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 16.
Nothing here hands control to plugin code.
13 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- regexregular expression over the whole input
preg_split()called directly
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_parse_list() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_array($input_list) | 9 | array_filter() |
!is_array($input_list) | 10 | preg_split() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 16 instructions, 9–10 executed per call, 1 branch. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
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.
Show all 13
- wp_parse_slug_list()Cleans up an array, comma- or space-separated list of slugs.
Source code
function wp_parse_list( $input_list ) { if ( ! is_array( $input_list ) ) { return preg_split( '/[\s,]+/', $input_list, -1, PREG_SPLIT_NO_EMPTY ); } // Validate all entries of the list are scalar. $input_list = array_filter( $input_list, 'is_scalar' ); return $input_list;}Changelog
Introduced in 5.1.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$input_list retyped from array|string to mixed[]|string.verified against sourceAbout 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.