Main entry point for the Requests HTTP library. This is a purely static class — it cannot be instantiated.

Source: wp-includes/Requests/src/Requests.php
Namespace: WpOrgRequests
Type: final-constructor static class

Constants

HTTP Method Constants

Other Constants

OPTION_DEFAULTS Detail

const OPTION_DEFAULTS = [
    'timeout'          => 10,
    'connect_timeout'  => 10,
    'useragent'        => 'php-requests/' . self::VERSION,
    'protocol_version' => 1.1,
    'redirected'       => 0,
    'redirects'        => 10,
    'follow_redirects' => true,
    'blocking'         => true,
    'type'             => self::GET,
    'filename'         => false,
    'auth'             => false,
    'proxy'            => false,
    'cookies'          => false,
    'max_bytes'        => false,
    'idn'              => true,
    'hooks'            => null,
    'transport'        => null,
    'verify'           => null,
    'verifyname'       => true,
];

Properties

Private Properties

Public Methods

get()

public static function get( string $url, array $headers = [], array $options = [] ): Response

Send a GET request. Delegates to request() with $data = null and $type = self::GET.

head()

public static function head( string $url, array $headers = [], array $options = [] ): Response

Send a HEAD request.

delete()

public static function delete( string $url, array $headers = [], array $options = [] ): Response

Send a DELETE request.

trace()

public static function trace( string $url, array $headers = [], array $options = [] ): Response

Send a TRACE request.

post()

public static function post( string $url, array $headers = [], array $data = [], array $options = [] ): Response

Send a POST request.

put()

public static function put( string $url, array $headers = [], array $data = [], array $options = [] ): Response

Send a PUT request.

options()

public static function options( string $url, array $headers = [], array $data = [], array $options = [] ): Response

Send an OPTIONS request.

patch()

public static function patch( string $url, array $headers, array $data = [], array $options = [] ): Response

Send a PATCH request. Note: $headers is required (not optional) because the RFC recommends sending an ETag.

request()

public static function request(
    string|Stringable $url,
    array $headers = [],
    array|null $data = [],
    string $type = self::GET,
    array $options = []
): Response

Main interface for HTTP requests. This is the core method all shorthand methods delegate to.

Returns: Response

Throws:

• InvalidArgument — When $url is not string/Stringable
• InvalidArgument — When $type is not a string
• InvalidArgument — When $options is not an array
• Exception — On invalid (non-HTTP) URLs (nonhttp)

Processing flow:

1. Validates arguments
2. Sets $options['type'] if empty
3. Merges with get_default_options()
4. Calls set_defaults() (normalizes auth, proxy, cookies, IDN)
5. Dispatches requests.before_request hook
6. Selects or creates transport (checks for SSL capability if HTTPS)
7. Calls $transport->request()
8. Dispatches requests.before_parse hook
9. Calls parse_response() for header/body splitting, decompression, redirects

request_multiple()

public static function request_multiple( array $requests, array $options = [] ): array

Send multiple HTTP requests simultaneously.

Returns: array — Array of Response objects (or Exception objects on failure)

Additional option: complete — callback called when each request completes, receives (&$response, $id).

Throws:

• InvalidArgument — When $requests is not array/iterable with array access
• InvalidArgument — When $options is not an array

has_capabilities()

public static function has_capabilities( array $capabilities = [] ): bool

Check if a transport is available for the given capabilities.

Returns: bool

add_transport()

public static function add_transport( string $transport ): void

Register a custom transport class. Must implement WpOrgRequestsTransport.

get_certificate_path()

public static function get_certificate_path(): string

Get the default certificate path.

set_certificate_path()

public static function set_certificate_path( string|Stringable|bool $path ): void

Set the default certificate path.

Throws: InvalidArgument — When $path is not string/Stringable/bool.

flatten()

public static function flatten( iterable $dictionary ): array

Convert a key => value array to a ['key: value'] array for headers.

Throws: InvalidArgument — When $dictionary is not iterable.

decompress()

public static function decompress( string $data ): string

Decompress gzip/deflate/compress encoded data. Attempts gzdecode(), gzinflate(), compatible_gzinflate(), then gzuncompress(). Returns original data if not compressed.

Throws: InvalidArgument — When $data is not a string.

compatible_gzinflate()

public static function compatible_gzinflate( string $gz_data ): string|bool

Decompression compatible with various server implementations. Handles gzip headers, Huffman encoding, and ZIP format.

Since: 1.6.0

Throws: InvalidArgument — When $gz_data is not a string.

parse_multiple()

public static function parse_multiple( string &$response, array $request ): void

Callback for transport.internal.parse_response. Converts raw HTTP response to Response object during multi-request processing. On failure, sets $response to an Exception.

Protected Methods