wp_remote_get() WordPress Function

The wp_remote_get() function is used to retrieve a remote URL and return its contents. This function is useful for making HTTP requests to external APIs or for fetching files from a remote server. The wp_remote_get() function can be used with the following parameters: • URL – The URL of the remote resource to fetch • args – An array of arguments to pass to the request • timeout – The maximum time in seconds to wait for the request to complete • headers – An array of HTTP headers to send with the request

wp_remote_get( string $url, array $args = array() ) #

Performs an HTTP request using the GET method and returns its response.


Description

Top ↑

See also


Top ↑

Parameters

$url

(string)(Required)URL to retrieve.

$args

(array)(Optional) Request arguments.

Default value: array()


Top ↑

Return

(array|WP_Error) The response or WP_Error on failure.


Top ↑

More Information

Use wp_remote_retrieve_body( $response ) to get the response body.

Use wp_remote_retrieve_response_code( $response ) to get the HTTP status code for the response.

Use related functions in wp-includes/http.php to get other parameters such as headers.

See WP_Http_Streams::request() method located in wp-includes/class-wp-http-streams.php for the format of the array returned by wp_remote_get().


Top ↑

Source

File: wp-includes/http.php

function wp_remote_get( $url, $args = array() ) {
	$http = _wp_http_get_object();
	return $http->get( $url, $args );
}


Top ↑

Changelog

Changelog
VersionDescription
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.