includes/Hook/WebResponseSetCookieHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 /**
   6  * This is a hook handler interface, see docs/Hooks.md.
   7  * Use the hook name "WebResponseSetCookie" to register handlers implementing this interface.
   8  *
   9  * @stable to implement
  10  * @ingroup Hooks
  11  */
  12 interface WebResponseSetCookieHook {
  13         /**
  14          * This hook is called when setting a cookie in WebResponse::setcookie().
  15          *
  16          * @since 1.35
  17          *
  18          * @param string &$name Cookie name passed to WebResponse::setcookie()
  19          * @param string &$value Cookie value passed to WebResponse::setcookie()
  20          * @param int|null &$expire Cookie expiration, as for PHP's setcookie()
  21          * @param array &$options Options passed to WebResponse::setcookie()
  22          * @return bool|void True or no return value to continue, or false to prevent setting of the cookie
  23          */
  24         public function onWebResponseSetCookie( &$name, &$value, &$expire, &$options );
  25 }