HandlerStack

A handler stack represents a stack of middleware to apply to a base handler function. You can push middleware to the stack to add to the top of the stack, and unshift middleware onto the stack to add to the bottom of the stack. When the stack is resolved, the handler is pushed onto the stack. Each value is then popped off of the stack, wrapping the previous value popped off of the stack.

  1. use GuzzleHttp\Client;
  2. use GuzzleHttp\HandlerStack;
  3. use GuzzleHttp\Middleware;
  4. use GuzzleHttp\Utils;
  5. use Psr\Http\Message\RequestInterface;
  7. $stack = new HandlerStack();
  8. $stack->setHandler(Utils::chooseHandler());
  10. $stack->push(Middleware::mapRequest(function (RequestInterface $r) {
  11.     echo 'A';
  12.     return $r;
  13. }));
  15. $stack->push(Middleware::mapRequest(function (RequestInterface $r) {
  16.     echo 'B';
  17.     return $r;
  18. }));
  20. $stack->push(Middleware::mapRequest(function (RequestInterface $r) {
  21.     echo 'C';
  22.     return $r;
  23. }));
  25. $client->request('GET', 'http://httpbin.org/');
  26. // echoes 'ABC';
  28. $stack->unshift(Middleware::mapRequest(function (RequestInterface $r) {
  29.     echo '0';
  30.     return $r;
  31. }));
  33. $client = new Client(['handler' => $stack]);
  34. $client->request('GET', 'http://httpbin.org/');
  35. // echoes '0ABC';

You can give middleware a name, which allows you to add middleware before other named middleware, after other named middleware, or remove middleware by name.

  1. use Psr\Http\Message\RequestInterface;
  2. use GuzzleHttp\Middleware;
  4. // Add a middleware with a name
  5. $stack->push(Middleware::mapRequest(function (RequestInterface $r) {
  6.     return $r->withHeader('X-Foo', 'Bar');
  7. }, 'add_foo'));
  9. // Add a middleware before a named middleware (unshift before).
  10. $stack->before('add_foo', Middleware::mapRequest(function (RequestInterface $r) {
  11.     return $r->withHeader('X-Baz', 'Qux');
  12. }, 'add_baz'));
  14. // Add a middleware after a named middleware (pushed after).
  15. $stack->after('add_baz', Middleware::mapRequest(function (RequestInterface $r) {
  16.     return $r->withHeader('X-Lorem', 'Ipsum');
  17. }));
  19. // Remove a middleware by name
  20. $stack->remove('add_foo');