wiki.techinc.nl/includes/Hook/GetCacheVaryCookiesHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

26 lines
689 B
PHP

<?php
namespace MediaWiki\Hook;
use OutputPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "GetCacheVaryCookies" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface GetCacheVaryCookiesHook {
/**
* Use this hook to get cookies that should vary cache options.
*
* @since 1.35
*
* @param OutputPage $out
* @param string[] &$cookies Array of cookie names. Add a value to it if you
* want to add a cookie that has to vary cache options.
* @return bool|void True or no return value to continue or false to abort
*/
public function onGetCacheVaryCookies( $out, &$cookies );
}