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

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


Description Description

See also See also


Top ↑

Parameters Parameters

$url

(string) (Required) URL to retrieve.

$args

(array) (Optional) Request arguments.

Default value: array()


Top ↑

Return Return

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


Top ↑

More Information 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 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

Changelog
Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content

    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.

  2. Skip to note 2 content
    Contributed by Codex

    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
    }
    
  3. Skip to note 5 content
    Contributed by Lisa Linn Allen

    replace wp_get_http( $url, $filename ) to get a remote file and write to the file system:

    $args_for_get = array(
    	'stream' => true,
    	'filename' => $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.

  4. Skip to note 7 content
    Contributed by Khoi Pro

    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;
    }
    
  5. Skip to note 8 content
    Contributed by Shah Alom
        $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
        }
    
  6. Skip to note 9 content
    Contributed by ancientro

    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'

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