wp_parse_str( string $input_string, array $result )
- Since
- 2.2.1
- Source
wp-includes/formatting.php:5158
Compatibility
- WordPress
- since 2.2.1
- 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_stringstring- The string to be parsed.
$resultarray- Variables will be stored in this array.
Performance profile
How much work a call to wp_parse_str() 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
- 13
- Plugin surface
- 1 hook
- Called by
- 9
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. The body compiles to 13.
Third-party callbacks on 'wp_parse_str' run inside this call, and their cost is not bounded by anything here.
9 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_parse_str() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 13 | parse_str(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 13 instructions, 13 executed per call, 0 branches. 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.
Hooks and filters fired · 1
One hook fires while wp_parse_str() runs, in this order:
- apply_filters( wp_parse_str )filterline 5168 (+10 into the body)
Filters the array of variables derived from a parsed string.
Uses · 1
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 9
- WP_REST_Request::from_url()Retrieves a WP_REST_Request object from a full URL.
- WP_REST_Server::serve_batch_request_v1()Serves the batch/v1 request.
- WP_REST_Widget_Types_Controller::register_routes()Registers the widget type routes.
- WP_REST_Widgets_Controller::get_item_schema()Retrieves the widget's schema, conforming to JSON Schema.
- add_query_arg()Retrieves a modified URL query string.
- paginate_links()Retrieves paginated links for archive post pages.
- twentyfourteen_paging_nav()Display navigation to next/previous set of posts when applicable.
- wp_parse_args()Merges user defined arguments into defaults array.
- wp_style_loader_src()Administration Screen CSS for changing the styles.
Source code
function wp_parse_str( $input_string, &$result ) { parse_str( (string) $input_string, $result ); /** * Filters the array of variables derived from a parsed string. * * @since 2.2.1 * * @param array $result The array populated with variables. */ $result = apply_filters( 'wp_parse_str', $result );}Changelog
Introduced in 2.2.1. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/formatting.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.