MediaWiki  master
MediaWiki\Hook\WebResponseSetCookieHook Interface Reference

Stable to implement. More...

Inheritance diagram for MediaWiki\Hook\WebResponseSetCookieHook:

Public Member Functions

 onWebResponseSetCookie (&$name, &$value, &$expire, &$options)
 This hook is called when setting a cookie in WebResponse::setcookie(). More...
 

Detailed Description

Stable to implement.

Definition at line 9 of file WebResponseSetCookieHook.php.

Member Function Documentation

◆ onWebResponseSetCookie()

MediaWiki\Hook\WebResponseSetCookieHook::onWebResponseSetCookie ( $name,
$value,
$expire,
$options 
)

This hook is called when setting a cookie in WebResponse::setcookie().

Since
1.35
Parameters
string&$nameCookie name passed to WebResponse::setcookie()
string&$valueCookie value passed to WebResponse::setcookie()
int | null&$expireCookie expiration, as for PHP's setcookie()
array&$optionsOptions passed to WebResponse::setcookie()
Returns
bool|void True or no return value to continue, or false to prevent setting of the cookie

Implemented in MediaWiki\HookContainer\HookRunner.


The documentation for this interface was generated from the following file: