WireHttp

get($url, $data = [], $options = [])

Send a GET request. Returns the response body as a string, or false on failure. See send() for available $options.

$response = $http->get('https://example.com/path/');

// With query parameters
$response = $http->get('https://example.com/path/', [
    'foo' => 'bar',
    'page' => 2,
]);

post($url, $data = [], $options = [])

Send a POST request. Sets a default application/x-www-form-urlencoded content-type header. Returns the response body as a string, or false on failure. See send() for available $options.

$response = $http->post('https://example.com/api/', [
    'name' => 'value',
]);

// POST raw JSON
$http->setHeader('content-type', 'application/json');
$response = $http->post('https://example.com/api/', json_encode($data));

put($url, $data = [], $options = [])

Send a PUT request. Returns the response body as a string, or false on failure. See send() for available $options.

$response = $http->put('https://example.com/api/123', ['status' => 'published']);

delete($url, $data = [], $options = [])

Send a DELETE request. Returns the response body as a string, or false on failure. See send() for available $options.

$response = $http->delete('https://example.com/api/123');

patch($url, $data = [], $options = [])

Send a PATCH request. Returns the response body as a string, or false on failure. See send() for available $options.

$response = $http->patch('https://example.com/api/123', ['title' => 'Updated']);

head($url, $data = [], $options = [])

Send a HEAD request. Returns an associative array of response headers, or false on failure. See send() for available $options.

$headers = $http->head('https://example.com/path/');
if(is_array($headers)) {
    echo $headers['content-type'];
}

status($url, $data = [], $textMode = false, $options = [])

Send a HEAD request and return the HTTP status code as an integer. When $textMode is true, returns a string like "200 OK". See send() for available $options.

$code = $http->status('https://example.com/path/');     // 200
$text = $http->status('https://example.com/path/', [], true); // "200 OK"

statusText($url, $data = [], $options = [])

Send a HEAD request and return the status code and text as a string like "200 OK". See send() for available $options.

echo $http->statusText('https://example.com/path/'); // "200 OK"

getJSON($url, $assoc = true, $data = [], $options = [])

Send a GET request and json_decode() the response. Returns an array (when $assoc is true) or object, or false on failure. See send() for available $options.

$data = $http->getJSON('https://example.com/api/data.json');
if(is_array($data)) {
    print_r($data);
}

send($url, $data = [], $method = 'POST', $options = [])

The underlying method that handles all request types. Prefer the dedicated methods (get(), post(), etc.) over calling this directly.

Options:

// Force a specific transport
$response = $http->send($url, $data, 'POST', ['use' => 'curl']);

download($fromURL, $toFile, $options = [])

Download a file from a URL and save it locally. Returns the filename on success. Throws WireException on any error.

$filename = $http->download('https://example.com/file.zip', '/tmp/file.zip');
echo "Downloaded to: $filename";

Options:

sendFile($filename, $options = [], $headers = [])

Send the contents of a file (or a data string) to the connected HTTP client with appropriate headers. Uses $config->fileContentTypes to determine content-type. Throws WireException if the file doesn't exist.

// Send a file to the browser
$http->sendFile('/path/to/document.pdf');

// Send with a custom download filename
$http->sendFile('/path/to/file.zip', [
    'downloadFilename' => 'archive.zip',
    'forceDownload' => true,
]);

// Send raw data instead of a file
$http->sendFile(false, [
    'data' => $csvContent,
    'downloadFilename' => 'export.csv',
]);

Options:

Returns the number of bytes sent (only when exit is false).

setHeader($key, $value)

Set a single request header. Header names are stored lowercase. Pass null as $value to remove the header.

$http->setHeader('accept', 'application/json');
$http->setHeader('authorization', 'Bearer abc123');
$http->setHeader('x-custom', null); // remove header

setHeaders(array $headers, $options = [])

Set multiple request headers at once. Merges with existing headers by default.

$http->setHeaders([
    'accept' => 'application/json',
    'authorization' => 'Bearer abc123',
]);

// Reset and replace all headers
$http->setHeaders(['accept' => 'text/html'], ['reset' => true]);

Options:

getHeaders()

Get all currently set request headers as an associative array (lowercase keys).

$headers = $http->getHeaders();

setCookie($name, $value)

Set a cookie for the next CURL request. Pass null as $value to remove.

$http->setCookie('PHPSESSID', 'abc123');
$http->post('https://example.com/', [], ['use' => 'curl']);

setUserAgent($userAgent) / getUserAgent()

Set or get the user-agent header.

$http->setUserAgent('MyApp/1.0');
echo $http->getUserAgent();

setData($data)

Set the data to send with the next request (overwrites existing data). Accepts an associative array or a raw string (for JSON, XML, etc.).

$http->setData(['name' => 'value']);
$http->setData(json_encode($data)); // raw string