WireHttp::send() method

Send the given $data array to a URL using given method (i.e. POST, GET, PUT, DELETE, etc.)

This method handles the implementation for the get/post/head/etc. methods. It is preferable to use one of those dedicated request methods rather than this one.

Usage

// basic usage
$bool = $http->send(string $url);

// usage with all arguments
$bool = $http->send(string $url, array $data = [], string $method = 'POST', array $options = []);

Arguments

Name	Type(s)	Description
`$url`	`string`	URL to send to (including http:// or https://).
`$data` (optional)	`array`	Array of data to send (if not already set before).
`$method` (optional)	`string`	Method to use (either POST, GET, PUT, DELETE or others as needed).
`$options` (optional)	`array`	Options to modify behavior. (This argument added in 3.0.124: `use` (string\|array): What types(s) to use, one of 'fopen', 'curl', 'socket' to allow only that type. Or in 3.0.192+ this may be an array of types to attempt them in order. Default in 3.0.192+ is [ 'curl', 'fopen', 'socket' ]. In prior versions default is 'auto' which attempts: fopen, curl, then socket. `resetRequest` (bool): Reset request headers/data after completing request? By default the request headers and data will remain in the WireHttp instance for re-use by the next request. If this is not your desired behavior then either call `$http->resetRequest()`, create a new WireHttp instance for each request, or specify this option as true. 3.0.253+ Default:false `headers` (array): Add these headers to the request, specify as `[ 'name' => 'value' ]` array. 3.0.253+ Default:[]

Return value

bool string

False on failure or string of contents received on success.

Hooking $http→send(…)

You can add your own hook events that are executed either before or after the $http->send(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $http->send(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('WireHttp::send', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireHttp = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $url = $event->arguments(0);
  $data = $event->arguments(1);
  $method = $event->arguments(2);
  $options = $event->arguments(3);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $url);
  $event->arguments(1, $data);
  $event->arguments(2, $method);
  $event->arguments(3, $options);
});

Hooking after

The 'after' hooks are called immediately after each $http->send(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('WireHttp::send', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireHttp = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $url = $event->arguments(0);
  $data = $event->arguments(1);
  $method = $event->arguments(2);
  $options = $event->arguments(3);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$http methods and properties

API reference based on ProcessWire core version 3.0.252