wp_remote_get( string $url, array $args = array() ): array|WP_Error

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

Description
- See also
Parameters
Return
More Information
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes
- Feedback
- Feedback

Description

Top ↑

Parameters

$url string Required

URL to retrieve.

$args array Optional

Request arguments.
See WP_Http::request() for information on accepted arguments.

More Arguments from WP_Http::request( ... $args )

Array or string of HTTP request arguments.

method string
Request method. Accepts 'GET', 'POST', 'HEAD', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', or 'PATCH'.
Some transports technically allow others, but should not be assumed. Default 'GET'.
timeout float
How long the connection should stay open in seconds. Default 5.
redirection int
Number of allowed redirects. Not supported by all transports.
Default 5.
httpversion string
Version of the HTTP protocol to use. Accepts '1.0' and '1.1'.
Default '1.0'.
user-agent string
User-agent value sent.
Default 'WordPress/' . get_bloginfo( 'version' ) . '; ' . get_bloginfo( 'url' ).
reject_unsafe_urls bool
Whether to pass URLs through wp_http_validate_url() .
Default false.
blocking bool
Whether the calling code requires the result of the request.
If set to false, the request will be sent to the remote server, and processing returned to the calling code immediately, the caller will know if the request succeeded or failed, but will not receive any response from the remote server. Default true.
headers string|array
Array or string of headers to send with the request.
cookies array
List of cookies to send with the request.
body string|array
Body to send with the request. Default null.
compress bool
Whether to compress the $body when sending the request.
Default false.
decompress bool
Whether to decompress a compressed response. If set to false and compressed content is returned in the response anyway, it will need to be separately decompressed. Default true.
sslverify bool
Whether to verify SSL for the request. Default true.
sslcertificates string
Absolute path to an SSL certificate .crt file.
Default ABSPATH . WPINC . '/certificates/ca-bundle.crt'.
stream bool
Whether to stream to a file. If set to true and no filename was given, it will be dropped it in the WP temp dir and its name will be set using the basename of the URL. Default false.
filename string
Filename of the file to write to when streaming. $stream must be set to true. Default null.
limit_response_size int
Size in bytes to limit the response to. Default null.

Default: 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. View all references

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

View on Trac View on GitHub

Top ↑

Uses

Uses
Uses	Description
_wp_http_get_object() wp-includes/http.php	Returns the initialized WP_Http Object

Top ↑

Used By

Used By
Used By	Description
WP_Site_Health::check_for_page_caching() wp-admin/includes/class-wp-site-health.php	Checks if site has page cache enabled or not.
WP_REST_Pattern_Directory_Controller::get_items() wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php	Search and retrieve block patterns metadata
get_block_editor_theme_styles() wp-includes/block-editor.php	Creates an array of theme styles to load into the block editor.
WP_Site_Health::wp_cron_scheduled_check() wp-admin/includes/class-wp-site-health.php	Runs the scheduled event to check and update the latest site health status for the website.
WP_Debug_Data::debug_data() wp-admin/includes/class-wp-debug-data.php	Static function for generating site debug data when required.
WP_Site_Health::get_test_rest_availability() wp-admin/includes/class-wp-site-health.php	Tests if the REST API is accessible.
WP_Site_Health::get_test_dotorg_communication() wp-admin/includes/class-wp-site-health.php	Tests if the site can communicate with WordPress.org.
wp_check_php_version() wp-admin/includes/misc.php	Checks if the user needs to update PHP.
wp_edit_theme_plugin_file() wp-admin/includes/file.php	Attempts to edit a file for a theme or plugin.
WP_Community_Events::get_events() wp-admin/includes/class-wp-community-events.php	Gets data about events near a particular location.
wp_install_maybe_enable_pretty_permalinks() wp-admin/includes/upgrade.php	Maybe enable pretty permalinks on installation.
network_step2() wp-admin/includes/network.php	Prints step 2 for Network installation process.
themes_api() wp-admin/includes/theme.php	Retrieves theme installer pages from the WordPress.org Themes API.
populate_network() wp-admin/includes/schema.php	Populate network settings.
get_core_checksums() wp-admin/includes/update.php	Gets and caches the checksums for the given version of WordPress.
plugins_api() wp-admin/includes/plugin-install.php	Retrieves plugin installer pages from the WordPress.org Plugins API.
wp_get_popular_importers() wp-admin/includes/import.php	Returns a list from WordPress.org of popular importer plugins.
wp_credits() wp-admin/includes/credits.php	Retrieves the contributor credits.
url_is_accessable_via_ssl() wp-includes/deprecated.php	Determines if the URL can be accessed over SSL.

Show 14 more used by Hide more used by

Top ↑

Changelog

Changelog
Version	Description
2.7.0	Introduced.

Top ↑

User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 16You must log in to vote on the helpfulness of this note

Contributed by Store Locator Plus — 7 years ago

Valid arguments for the second parameter can be found in class-http.php in the header. There is not easy way to reference the list on the current version of this guide so I’m pasting the PHPDoc header here. Hopefully the docs site will expand the WP_Http page or find a way to reference the valid parameters through indirection while the robots build these pages.

* @param string|array $args { * Optional. Array or string of HTTP request arguments. * * @type string $method Request method. Accepts 'GET', 'POST', 'HEAD', or 'PUT'. * Some transports technically allow others, but should not be * assumed. Default 'GET'. * @type int $timeout How long the connection should stay open in seconds. Default 5. * @type int $redirection Number of allowed redirects. Not supported by all transports * Default 5. * @type string $httpversion Version of the HTTP protocol to use. Accepts '1.0' and '1.1'. * Default '1.0'. * @type string $user-agent User-agent value sent. * Default WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ). * @type bool $reject_unsafe_urls Whether to pass URLs through wp_http_validate_url(). * Default false. * @type bool $blocking Whether the calling code requires the result of the request. * If set to false, the request will be sent to the remote server, * and processing returned to the calling code immediately, the caller * will know if the request succeeded or failed, but will not receive * any response from the remote server. Default true. * @type string|array $headers Array or string of headers to send with the request. * Default empty array. * @type array $cookies List of cookies to send with the request. Default empty array. * @type string|array $body Body to send with the request. Default null. * @type bool $compress Whether to compress the $body when sending the request. * Default false. * @type bool $decompress Whether to decompress a compressed response. If set to false and * compressed content is returned in the response anyway, it will * need to be separately decompressed. Default true. * @type bool $sslverify Whether to verify SSL for the request. Default true. * @type string sslcertificates Absolute path to an SSL certificate .crt file. * Default ABSPATH . WPINC . '/certificates/ca-bundle.crt'. * @type bool $stream Whether to stream to a file. If set to true and no filename was * given, it will be droped it in the WP temp dir and its name will * be set using the basename of the URL. Default false. * @type string $filename Filename of the file to write to when streaming. $stream must be * set to true. Default null. * @type int $limit_response_size Size in bytes to limit the response to. Default null.
Top ↑
Feedback
- Nowadays there is a way to reference the $args: https://developer.wordpress.org/reference/classes/WP_Http/request/ — By Andrija Naglic — 8 months ago
Log in to add feedback

Contributed by Codex — 8 years ago

Get a remote URL

/** @var array|WP_Error $response */
$response = wp_remote_get( 'http://www.example.com/index.html' );

if ( is_array( $response ) && ! is_wp_error( $response ) ) {
	$headers = $response['headers']; // array of http header lines
	$body    = $response['body']; // use the content
}

Contributed by Kalimah Apps — 2 years ago

The top comment by Store Locator Plus adds good information but it is hard to read.

To find the arguments you can see WP_Http::request documentation or see below for a formatted PHPDoc version:

/**
* @param string|array $args {
*     Optional. Array or string of HTTP request arguments.
*
*     @type string       $method              Request method. Accepts 'GET', 'POST', 'HEAD', 'PUT', 'DELETE',
*                                             'TRACE', 'OPTIONS', or 'PATCH'.
*                                             Some transports technically allow others, but should not be
*                                             assumed. Default 'GET'.
*     @type float        $timeout             How long the connection should stay open in seconds. Default 5.
*     @type int          $redirection         Number of allowed redirects. Not supported by all transports
*                                             Default 5.
*     @type string       $httpversion         Version of the HTTP protocol to use. Accepts '1.0' and '1.1'.
*                                             Default '1.0'.
*     @type string       $user-agent          User-agent value sent.
*                                             Default 'WordPress/' . get_bloginfo( 'version' ) . '; ' . get_bloginfo( 'url' ).
*     @type bool         $reject_unsafe_urls  Whether to pass URLs through wp_http_validate_url().
*                                             Default false.
*     @type bool         $blocking            Whether the calling code requires the result of the request.
*                                             If set to false, the request will be sent to the remote server,
*                                             and processing returned to the calling code immediately, the caller
*                                             will know if the request succeeded or failed, but will not receive
*                                             any response from the remote server. Default true.
*     @type string|array $headers             Array or string of headers to send with the request.
*                                             Default empty array.
*     @type array        $cookies             List of cookies to send with the request. Default empty array.
*     @type string|array $body                Body to send with the request. Default null.
*     @type bool         $compress            Whether to compress the $body when sending the request.
*                                             Default false.
*     @type bool         $decompress          Whether to decompress a compressed response. If set to false and
*                                             compressed content is returned in the response anyway, it will
*                                             need to be separately decompressed. Default true.
*     @type bool         $sslverify           Whether to verify SSL for the request. Default true.
*     @type string       $sslcertificates     Absolute path to an SSL certificate .crt file.
*                                             Default ABSPATH . WPINC . '/certificates/ca-bundle.crt'.
*     @type bool         $stream              Whether to stream to a file. If set to true and no filename was
*                                             given, it will be droped it in the WP temp dir and its name will
*                                             be set using the basename of the URL. Default false.
*     @type string       $filename            Filename of the file to write to when streaming. $stream must be
*                                             set to true. Default null.
*     @type int          $limit_response_size Size in bytes to limit the response to. Default null.
*
* }
*/

Skip to note 4 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by Codex — 8 years ago
Get a remote URL with special arguments
```
/** @var array|WP_Error $response */
$response = wp_remote_get( 'http://www.example.com/index.php?action=foo',
	array(
		'timeout'     => 120,
		'httpversion' => '1.1',
	)
);
```
Log in to add feedback
Skip to note 5 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by dleeward — 5 years ago
When adding headers, each part of the header has to be a separate element like this:
```
$args = array(
	  'headers' => array(
		'Content-Type' => 'application/json',
		'X-Api-Key' => 'apikey12345'
	  ) 
```
not like cURL where you can use ‘Content-Type: application/json’
Log in to add feedback
Skip to note 6 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by ancientro — 3 years ago
If you load data from an API and have set a domain restriction on the API key (such as only allow on “www.example.com/*”), you need to set the “referer” in “headers” in $args, as wp_remote_get() does not set the referer automatically:
```
$response = wp_remote_get(
	esc_url_raw( $api_url ),
	array(
		'headers' => array(
			'referer' => home_url()
		)
	)
);
```
Or, as a string, to work on your localhost as well:
```
'referer' => 'www.example.com'
```
Log in to add feedback
Skip to note 7 content

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

Contributed by Manny (emanweb) — 5 years ago

It would be cool to have a link to this somewhere on this page: https://developer.wordpress.org/reference/functions/wp_safe_remote_get/

Log in to add feedback
Skip to note 8 content

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

Contributed by Lisa Linn Allen — 5 years ago
replace wp_get_http( $url, $filename ) to get a remote file and write to the file system:
```
$args_for_get = array(
	'stream' =&gt; true,
	'filename' =&gt; $filename,
);
$response = wp_remote_get( $url, $args_for_get );
```
Thank you @charlestonsw for pasting in the comments with the meaning of all the args, which lead me to this simple replacement.
Log in to add feedback
Skip to note 9 content

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Contributed by Khoi Pro — 5 years ago
It’s better to execute JSON response like that to keep it managed.
```
$request = wp_remote_get($url, $options);

return load_request($request);

function load_request($response) {
  try {
    $json = json_decode( $response['body'] );
  } catch ( Exception $ex ) {
    $json = null;
  }
  return $json;
}
```
Log in to add feedback
Skip to note 10 content

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Contributed by Namith Jawahar — 1 year ago
An example for reading a JSON response from an API end point with error checking.
Here we are checking for the response code of 200 utilizing the wp_remote_retrieve_response_code() function and also verifying there are no JSON errors during the json_decode() function call utilising the json_last_error() function.
```
try {
	$response = wp_remote_get( 'https://yourapi.end/point/', array(
		'headers' => array(
			'Accept' => 'application/json',
		)
	) );
	if ( ( !is_wp_error($response)) && (200 === wp_remote_retrieve_response_code( $response ) ) ) {
		$responseBody = json_decode($response['body']);
		if( json_last_error() === JSON_ERROR_NONE ) {
			//Do your thing.
		}
	}
} catch( Exception $ex ) {
	//Handle Exception.
}
```
Log in to add feedback
Skip to note 11 content

You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note

Contributed by Shah Alom — 4 years ago
```
    $apiUrl = 'https://example.com/wp-json/wp/v2/posts?page=0&per_page=0';
    $response = wp_remote_get($apiUrl);
    $responseBody = wp_remote_retrieve_body( $response );
    $result = json_decode( $responseBody );
    if ( is_array( $result ) && ! is_wp_error( $result ) ) {
        // Work with the $result data
    } else {
        // Work with the error
    }
```
Top ↑
Feedback
- $result = json_decode($responseBody); if success as it is will return an object and not a array, my friend, so the if will fail even if there are no errors. Consider changing line 4 to: $result = json_decode($responseBody, true); — By Marcos Silva — 3 years ago
- json_decode() is native to PHP, and so will never return an instance of WP_Error object; that check is unnecessary, or, should be adjusted to check $response. — By crstauf — 3 years ago
Log in to add feedback