WP_Http::_dispatch_request( string $url, array $args ): array|WP_Error
- Since
- 3.2.0
- Source
wp-includes/class-wp-http.php:598
Description
Tests each transport in order to find a transport which matches the request arguments.
Also caches the transport instance to be used later.
The order for requests is cURL, and then PHP Streams.
Compatibility
Deprecated in WordPress 5.1.0. Use WP_Http::request()
- WordPress
- since 3.2.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
$urlstring- URL to request.
$argsarray- Request arguments.
Return value
array|WP_Error- Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
A WP_Error instance upon error.
Performance profile
How much work a call to WP_Http::_dispatch_request() 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
- 17–41
- Plugin surface
- 2 hooks
- Called by
- 0
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 50.
Third-party callbacks on 'http_api_debug', 'http_response' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()called directly
Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Http::_dispatch_request() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 17 | ->_get_first_available_transport(), __() |
is_wp_error() | 30–35 | ->_get_first_available_transport(), ->request(), do_action(), is_wp_error() |
!is_wp_error() | 36–41 | ->_get_first_available_transport(), ->request(), do_action(), is_wp_error(), 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: 50 instructions, 17–41 executed per call, 3 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 · 2
2 hooks fire while WP_Http::_dispatch_request() runs, in this order:
- do_action( http_api_debug )actionline 614 (+16 into the body)
Fires after an HTTP API response is received and before the response is returned.
- apply_filters( http_response )filterline 621 (+23 into the body)
Filters a successful HTTP API response immediately before the response is returned.
Uses · 6
- __()Retrieves the translation of $text.
- do_action()Calls the callback functions that have been added to an action hook.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- WP_Http::_get_first_available_transport()Tests which transports are capable of supporting the request.
- WP_Error::__construct()Initializes the error.
Source code
private function _dispatch_request( $url, $args ) { static $transports = array(); $class = $this->_get_first_available_transport( $args, $url ); if ( ! $class ) { return new WP_Error( 'http_failure', __( 'There are no HTTP transports available which can complete the requested request.' ) ); } // Transport claims to support request, instantiate it and give it a whirl. if ( empty( $transports[ $class ] ) ) { $transports[ $class ] = new $class(); } $response = $transports[ $class ]->request( $url, $args ); /** This action is documented in wp-includes/class-wp-http.php */ do_action( 'http_api_debug', $response, 'response', $class, $args, $url ); if ( is_wp_error( $response ) ) { return $response; } /** This filter is documented in wp-includes/class-wp-http.php */ return apply_filters( 'http_response', $response, $args, $url ); }Changelog
Introduced in 3.2.0. 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 7.0.4 tag, from
src/wp-includes/class-wp-http.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.