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

Twitter updates

  • ProcessWire 3.0.192 (dev branch) contains 11 issue fixes and 5 pull requests, over 20 commits— More
    7 January 2022
  • ProcessWire 3.0.191 core updates: updates to the installer and the profile exporter module— More
    24 December 2021
  • This week ProcessWire went on a diet, trimming the core size from 15.5 MB down to 7.5 MB by moving optional site profiles into their own GitHub repos— More
    17 December 2021

Latest news

  • ProcessWire Weekly #401
    In the 401st issue of ProcessWire Weekly we'll cover the latest core updates, check out a brand new module called Lister Native Date Format, and more. Read on!
    Weekly.pw / 15 January 2022
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH