[ Index ]

PHP Cross Reference of WordPress




/wp-includes/ -> class-wp-http-requests-response.php (summary)

HTTP API: WP_HTTP_Requests_Response class

File Size: 197 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_HTTP_Requests_Response:: (11 methods):

Class: WP_HTTP_Requests_Response  - X-Ref

Core wrapper object for a Requests_Response for standardisation.

__construct( Requests_Response $response, $filename = '' )   X-Ref

param: Requests_Response $response HTTP response.
param: string            $filename Optional. File name. Default empty.
since: 4.6.0

get_response_object()   X-Ref
Retrieves the response object for the request.

return: Requests_Response HTTP response.
since: 4.6.0

get_headers()   X-Ref
Retrieves headers associated with the response.

return: \Requests_Utility_CaseInsensitiveDictionary Map of header name to header value.
since: 4.6.0

set_headers( $headers )   X-Ref
Sets all header values.

param: array $headers Map of header name to header value.
since: 4.6.0

header( $key, $value, $replace = true )   X-Ref
Sets a single HTTP header.

param: string $key     Header name.
param: string $value   Header value.
param: bool   $replace Optional. Whether to replace an existing header of the same name.
since: 4.6.0

get_status()   X-Ref
Retrieves the HTTP return code for the response.

return: int The 3-digit HTTP status code.
since: 4.6.0

set_status( $code )   X-Ref
Sets the 3-digit HTTP status code.

param: int $code HTTP status.
since: 4.6.0

get_data()   X-Ref
Retrieves the response data.

return: string Response data.
since: 4.6.0

set_data( $data )   X-Ref
Sets the response data.

param: string $data Response data.
since: 4.6.0

get_cookies()   X-Ref
Retrieves cookies from the response.

return: WP_HTTP_Cookie[] List of cookie objects.
since: 4.6.0

to_array()   X-Ref
Converts the object to a WP_Http response array.

return: array WP_Http response array, per WP_Http::request().
since: 4.6.0

Generated: Fri Jul 12 01:00:02 2024 Cross-referenced by PHPXref 0.7.1