wp_remote_request() WordPress Function

The wp_remote_request() function is used to make HTTP requests to another site. This is useful for making calls to APIs or for fetching data from another website. The function takes an array of arguments, which includes the URL to request, the HTTP method to use, and an array of headers.

wp_remote_request( string $url, array $args = array() ) #

Performs an HTTP request and returns its response.


Description

There are other API functions available which abstract away the HTTP method:

Top ↑

See also


Top ↑

Parameters

$url

(string)(Required)URL to retrieve.

$args

(array)(Optional) Request arguments.

Default value: array()


Top ↑

Return

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

  • 'headers'
    (string[]) Array of response headers keyed by their name.
  • 'body'
    (string) Response body.
  • 'response'
    (array) Data about the HTTP response.
    • 'code'
      (int|false) HTTP response code.
    • 'message'
      (string|false) HTTP response message.
  • 'cookies'
    (WP_HTTP_Cookie[]) Array of response cookies.
  • 'http_response'
    (WP_HTTP_Requests_Response|null) Raw HTTP response object.


Top ↑

Source

File: wp-includes/http.php

function wp_remote_request( $url, $args = array() ) {
	$http = _wp_http_get_object();
	return $http->request( $url, $args );
}


Top ↑

Changelog

Changelog
VersionDescription
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.