Codex

Function API/wp remote get

Contents

Description

Retrieves a URL using the HTTP GET method, returning results in an array. Results include HTTP headers and content.

See Function_API/wp_remote_post for using the HTTP POST method.

Usage

 <?php wp_remote_get$url$args ); ?> 

Parameters

$url
(string) (required) Universal Resource Locator (URL).
Default: None
$args
(array) (optional) Optional. See HTTP_API#Other_Arguments for argument details. Note: If sending any array arguments (headers, cookies, etc.) then all of them must be included since array arguments are not "deep" merged.
Default: method: GET, timeout: 5, redirection: 5, httpversion: 1.0, blocking: true, headers: array(), body: null, cookies: array()

Return Values

Array of results including HTTP headers, WP_Error object on failure. print_r results of requesting a simple web page using default arguments:

Array
(
    [headers] => Array
        (
            [date] => Thu, 30 Sep 2010 15:16:36 GMT
            [server] => Apache
            [x-powered-by] => PHP/5.3.3
            [x-server] => 10.90.6.243
            [expires] => Thu, 30 Sep 2010 03:16:36 GMT
            [cache-control] => Array
                (
                    [0] => no-store, no-cache, must-revalidate
                    [1] => post-check=0, pre-check=0
                )

            [vary] => Accept-Encoding
            [content-length] => 1641
            [connection] => close
            [content-type] => application/php
        )
    [body] => <html>This is a website!</html>
    [response] => Array
        (
            [code] => 200
            [message] => OK
        )

    [cookies] => Array
        (
        )

)

Examples

$response = wp_remote_get( $url );
if( is_wp_error( $response ) ) {
   $error_message = $response->get_error_message();
   echo "Something went wrong: $error_message";
} else {
   echo 'Response:<pre>';
   print_r( $response );
   echo '</pre>';
}

In the example above, $response['body'] will contain the actual page content returned by the server.

Change Log

Source File

wp_remote_get() is located in wp-includes/http.php.

Related