| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
Simple and uniform HTTP request API. Will eventually replace and standardize the WordPress HTTP requests made.
| File Size: | 301 lines (8 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| _wp_http_get_object() X-Ref |
| Returns the initialized WP_Http Object return: WP_Http HTTP Transport object. |
| wp_remote_request($url, $args = array() X-Ref |
| Retrieve the raw response from the HTTP request. The array structure is a little complex. <code> $res = array( 'headers' => array(), 'response' => array('code' => int, 'message' => string) ); </code> All of the headers in $res['headers'] are with the name as the key and the value as the value. So to get the User-Agent, you would do the following. <code> $user_agent = $res['headers']['user-agent']; </code> The body is the raw response content and can be retrieved from $res['body']. This function is called first to make the request and there are other API functions to abstract out the above convoluted setup. param: string $url Site URL to retrieve. param: array $args Optional. Override the defaults. return: WP_Error|array The response or WP_Error on failure. |
| wp_remote_get($url, $args = array() X-Ref |
| Retrieve the raw response from the HTTP request using the GET method. param: string $url Site URL to retrieve. param: array $args Optional. Override the defaults. return: WP_Error|array The response or WP_Error on failure. |
| wp_remote_post($url, $args = array() X-Ref |
| Retrieve the raw response from the HTTP request using the POST method. param: string $url Site URL to retrieve. param: array $args Optional. Override the defaults. return: WP_Error|array The response or WP_Error on failure. |
| wp_remote_head($url, $args = array() X-Ref |
| Retrieve the raw response from the HTTP request using the HEAD method. param: string $url Site URL to retrieve. param: array $args Optional. Override the defaults. return: WP_Error|array The response or WP_Error on failure. |
| wp_remote_retrieve_headers(&$response) X-Ref |
| Retrieve only the headers from the raw response. param: array $response HTTP response. return: array The headers of the response. Empty array if incorrect parameter given. |
| wp_remote_retrieve_header(&$response, $header) X-Ref |
| Retrieve a single header by name from the raw response. param: array $response param: string $header Header name to retrieve value from. return: string The header value. Empty string on if incorrect parameter given, or if the header doesn't exist. |
| wp_remote_retrieve_response_code(&$response) X-Ref |
| Retrieve only the response code from the raw response. Will return an empty array if incorrect parameter value is given. param: array $response HTTP response. return: string the response code. Empty string on incorrect parameter given. |
| wp_remote_retrieve_response_message(&$response) X-Ref |
| Retrieve only the response message from the raw response. Will return an empty array if incorrect parameter value is given. param: array $response HTTP response. return: string The response message. Empty string on incorrect parameter given. |
| wp_remote_retrieve_body(&$response) X-Ref |
| Retrieve only the body from the raw response. param: array $response HTTP response. return: string The body of the response. Empty string if no body or incorrect parameter given. |
| wp_http_supports( $capabilities = array() X-Ref |
| Determines if there is an HTTP Transport that can process this request. param: array $capabilities Array of capabilities to test or a wp_remote_request() $args array. param: string $url Optional. If given, will check if the URL requires SSL and adds that requirement to the capabilities array. return: bool |
| get_http_origin() X-Ref |
| Get the HTTP Origin of the current request. return: string URL of the origin. Empty string if no origin. |
| get_allowed_http_origins() X-Ref |
| Retrieve list of allowed http origins. return: array Array of origin URLs. |
| is_allowed_http_origin( $origin = null ) X-Ref |
| Determines if the http origin is an authorized one. param: string Origin URL. If not provided, the value of get_http_origin() is used. return: bool True if the origin is allowed. False otherwise. |
| send_origin_headers() X-Ref |
| Send Access-Control-Allow-Origin and related headers if the current request is from an allowed origin. return: bool|string Returns the origin URL if headers are sent. Returns false |
| Generated: Fri May 25 03:56:23 2012 | Hosted by follow the white rabbit. |