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

NameType(s)Description
urlstring

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.

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.200

Twitter updates

  • New TinyMCE 6.2.0 Inputfield released for ProcessWire— More
    28 October 2022
  • This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it— More
    21 October 2022
  • This week we have ProcessWire 3.0.206 on the dev branch and a new version of the ProDevTools UserActivity module, which we'll take a closer look at in this post— More
    7 October 2022

Latest news

  • ProcessWire Weekly #447
    In the 447th issue of ProcessWire Weekly we'll share the latest core updates, introduce a new third party module called RockVideoThumbnailGrabber, and more. Read on!
    Weekly.pw / 3 December 2022
  • New rich text editor for ProcessWire
    This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it.
    Blog / 21 October 2022
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK