wp_remote_retrieve_body( array|WP_Error $response ): string
- Since
- 2.7.0
- Source
wp-includes/http.php:316
Compatibility
- WordPress
- since 2.7.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
$responsearray|WP_Error- HTTP response.
Return value
string- The body of the response. Empty string if no body or incorrect parameter given.
Performance profile
How much work a call to wp_remote_retrieve_body() 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
- 6–9
- Plugin surface
- None
- Called by
- 33
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 10.
Nothing here hands control to plugin code.
33 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()one call below wp_remote_retrieve_body()
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_remote_retrieve_body() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6–9 | is_wp_error() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 6–9 executed per call, 2 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.
Uses · 1
- is_wp_error()Checks whether the given variable is a WordPress Error.
Used by · 33
- WP_AI_Client_HTTP_Client::create_psr_response()Creates a PSR-7 response from a WordPress HTTP response.
- WP_Automatic_Updater::has_fatal_error()Performs a loopback request to check for potential fatal errors.
- WP_Community_Events::get_events()Gets data about events near a particular location.
- WP_Font_Collection::load_from_url()Loads the font collection data from a JSON file URL.
- WP_HTTP_IXR_Client::query()
- WP_REST_Pattern_Directory_Controller::get_items()Search and retrieve block patterns metadata
- WP_REST_URL_Details_Controller::get_remote_url()Retrieves the document title from a remote URL.
- WP_SimplePie_File::__construct()Constructor.
- WP_Site_Health::get_test_rest_availability()Tests if the REST API is accessible.
- WP_Site_Health::wp_cron_scheduled_check()Runs the scheduled event to check and update the latest site health status for the website.
- WP_oEmbed::_fetch_with_format()Fetches result from an oEmbed provider for a specific format and complete provider URL
- WP_oEmbed::discover()Attempts to discover link tags at the given URL for an oEmbed provider.
Show all 33
- _fetch_remote_file()Retrieve URL headers and content using WP HTTP Request API.
- discover_pingback_server_uri()Finds a pingback server URI based on the given URL.
- download_url()Downloads a URL to a local temporary file using the WordPress HTTP API.
- get_block_editor_theme_styles()Creates an array of theme styles to load into the block editor.
- get_core_checksums()Gets and caches the checksums for the given version of WordPress.
- network_step2()Prints step 2 for Network installation process.
- plugins_api()Retrieves plugin installer pages from the WordPress.org Plugins API.
- themes_api()Retrieves theme installer pages from the WordPress.org Themes API.
- translations_api()Retrieve translations from WordPress Translation API.
- wp_check_browser_version()Checks if the user needs a browser update.
- wp_check_php_version()Checks if the user needs to update PHP.
- wp_credits()Retrieves the contributor credits.
- wp_edit_theme_plugin_file()Attempts to edit a file for a theme or plugin.
- wp_get_http()Perform a HTTP HEAD or GET request.
- wp_get_https_detection_errors()Runs a remote HTTPS request to detect whether HTTPS supported, and stores potential errors.
- wp_get_popular_importers()Returns a list from WordPress.org of popular importer plugins.
- wp_remote_fopen()HTTP request for URI to retrieve content.
- wp_update_plugins()Checks for available updates to plugins based on the latest versions hosted on WordPress.org.
- wp_update_themes()Checks for available updates to themes based on the latest versions hosted on WordPress.org.
- wp_version_check()Checks WordPress version against the newest version.
- wp_xmlrpc_server::pingback_ping()Retrieves a pingback and registers it.
Source code
function wp_remote_retrieve_body( $response ) { if ( is_wp_error( $response ) || ! isset( $response['body'] ) ) { return ''; } return $response['body'];}Changelog
Introduced in 2.7.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.1.0 tag, from
src/wp-includes/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.