MediaWiki  master
MediaWiki\Hook\GetCacheVaryCookiesHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Hook\GetCacheVaryCookiesHook:

Public Member Functions

 onGetCacheVaryCookies ( $out, &$cookies)
 Use this hook to get cookies that should vary cache options. More...
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "GetCacheVaryCookies" to register handlers implementing this interface.

Stable to implement

Definition at line 14 of file GetCacheVaryCookiesHook.php.

Member Function Documentation

◆ onGetCacheVaryCookies()

MediaWiki\Hook\GetCacheVaryCookiesHook::onGetCacheVaryCookies (   $out,
$cookies 
)

Use this hook to get cookies that should vary cache options.

Since
1.35
Parameters
OutputPage$out
string[]&$cookiesArray of cookie names. Add a value to it if you want to add a cookie that has to vary cache options.
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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