wp_safe_remote_request( string $url, array $args = array() ): array|WP_Error
Retrieve the raw response from a safe HTTP request.
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.
See also
- wp_remote_request() : For more information on the response array format.
- WP_Http::request(): For default arguments information.
Parameters
-
$urlstring Required -
URL to retrieve.
-
$argsarray 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.
methodstringRequest method. Accepts'GET','POST','HEAD','PUT','DELETE','TRACE','OPTIONS', or'PATCH'.
Some transports technically allow others, but should not be assumed. Default'GET'.timeoutfloatHow long the connection should stay open in seconds. Default 5.redirectionintNumber of allowed redirects. Not supported by all transports.
Default 5.httpversionstringVersion of the HTTP protocol to use. Accepts'1.0'and'1.1'.
Default'1.0'.user-agentstringUser-agent value sent.
Default'WordPress/'. get_bloginfo('version') . '; ' . get_bloginfo('url').reject_unsafe_urlsboolblockingboolWhether 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.headersstring|arrayArray or string of headers to send with the request.
cookiesarrayList of cookies to send with the request.bodystring|arrayBody to send with the request. Default null.compressboolWhether to compress the $body when sending the request.
Default false.decompressboolWhether 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.sslverifyboolWhether to verify SSL for the request. Default true.sslcertificatesstringAbsolute path to an SSL certificate .crt file.
Default ABSPATH . WPINC .'/certificates/ca-bundle.crt'.streamboolWhether 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.filenamestringFilename of the file to write to when streaming. $stream must be set to true. Default null.limit_response_sizeintSize in bytes to limit the response to. Default null.
Default:
array()
Return
Source
File: wp-includes/http.php.
View all references
function wp_safe_remote_request( $url, $args = array() ) {
$args['reject_unsafe_urls'] = true;
$http = _wp_http_get_object();
return $http->request( $url, $args );
}
Changelog
| Version | Description |
|---|---|
| 3.6.0 | Introduced. |