includes/Hook/GetCacheVaryCookiesHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use MediaWiki\Output\OutputPage;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "GetCacheVaryCookies" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface GetCacheVaryCookiesHook {
  15         /**
  16          * Use this hook to get cookies that should vary cache options.
  17          *
  18          * @since 1.35
  19          *
  20          * @param OutputPage $out
  21          * @param string[] &$cookies Array of cookie names. Add a value to it if you
  22          *   want to add a cookie that has to vary cache options.
  23          * @return bool|void True or no return value to continue or false to abort
  24          */
  25         public function onGetCacheVaryCookies( $out, &$cookies );
  26 }