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): What handler to use, one of 'auto', 'fopen', 'curl' or 'socket' (default='auto') If the 'auto' option is used, the method will first try fopen and then fallback to curl and sockets unless 'fallback' is disabled.
  • fallback (bool|string): Allow fallback to other methods? Applies only if 'use' option is 'auto'. (default=true) For a specific fallback method specify 'socket' or 'curl'

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

Twitter updates

  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020
  • If you haven't seen it yet, be sure to check out this great infographic by @teppokoivula in ProcessWire Weekly #294— How ProcessWire professionals work—the results of our recent weekly polls summarised: weekly.pw/issue/294/#how…
    3 January 2020
  • Today we have a new master version released, 3.0.148! There are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we take a closer look at what’s new, how to upgrade, & more— More
    3 January 2020

Latest news

  • ProcessWire Weekly #296
    In the 296th issue of ProcessWire Weekly we're going to introduce the newly released front-end file uploads support for LoginRegisterPro, introduce a couple of third party modules, and more. Read on!
    Weekly.pw / 11 January 2020
  • ProcessWire 3.0.148 new master
    Today we have a new master version released, version 3.0.148! The last master version was 3.0.123, so there are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we’ll take a closer look at what’s new, how to upgrade, and more.
    Blog / 3 January 2020
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer