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

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

Contents

Description

This function is ideal when the HTTP request is being made to an arbitrary URL. The URL is validated to avoid redirection and request forgery attacks.

Top ↑

See also

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 ↑

Source

File: wp-includes/http.php. View all references 

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

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
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 2 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
3.6.0 Introduced.

Top ↑

User Contributed Notes

  2. Skip to note 2 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 Mindaugas Jakubauskas —

    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(),
	),
);

You must log in before being able to contribute a note or feedback.