wp_safe_remote_get() – Function | Developer.WordPress.org

Retrieves the raw response from a safe HTTP request using the GET method.

Description

This function is ideal when the HTTP request is being made to an arbitrary URL. The URL, and every URL it redirects to, are validated with wp_http_validate_url() to avoid Server Side Request Forgery attacks (SSRF).

Parameters

$urlstringrequired: URL to retrieve.
$argsarrayoptional: Request arguments.
See WP_Http::request() for information on accepted arguments.
Default:array()

Return

array|WP_Error The response or WP_Error on failure.
See WP_Http::request() for information on return value.

Source

function wp_safe_remote_get( $url, $args = array() ) {
	$args['reject_unsafe_urls'] = true;
	$http                       = _wp_http_get_object();
	return $http->get( $url, $args );
}

View all references View on Trac View on GitHub

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

Used by	Description
WP_Font_Collection::load_from_url()`wp-includes/fonts/class-wp-font-collection.php`	Loads the font collection data from a JSON file URL.
WP_REST_URL_Details_Controller::get_remote_url()`wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php`	Retrieves the document title from a remote URL.
download_url()`wp-admin/includes/file.php`	Downloads a URL to a local temporary file using the WordPress HTTP API.
wp_remote_fopen()`wp-includes/functions.php`	HTTP request for URI to retrieve content.
WP_oEmbed::discover()`wp-includes/class-wp-oembed.php`	Attempts to discover link tags at the given URL for an oEmbed provider.
WP_oEmbed::_fetch_with_format()`wp-includes/class-wp-oembed.php`	Fetches result from an oEmbed provider for a specific format and complete provider URL
wp_xmlrpc_server::pingback_ping()`wp-includes/class-wp-xmlrpc-server.php`	Retrieves a pingback and registers it.
discover_pingback_server_uri()`wp-includes/comment.php`	Finds a pingback server URI based on the given URL.

Show 3 more Show less

Changelog

Version	Description
3.6.0	Introduced.

User Contributed Notes

Skip to note 3 content

InfiWebs 8 years ago

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
Retrieving and decoding json file –
```
$request = wp_safe_remote_get( 'http://www.example.com/file.json' );

if ( is_wp_error( $request ) ) {
	return false;
}

$body = wp_remote_retrieve_body( $request );
$json = json_decode( $body );
```
Log in to add feedback

Mindaugas Jakubauskas 5 years ago

Request with authorization parameters

$response = wp_safe_remote_get( 
	'https://endpoint-uri.com/example', 
	array(
		'timeout'     => 45,
		'redirection' => 5,
		'headers'     => array(
			'Content-Type' => 'application/json; charset=utf-8',
			'Authorization'      => 'Basic AUTH_KEY_HERE',
		),
		'cookies'     => array(),
	),
);

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

In this article