includes/api/Hook/RequestHasSameOriginSecurityHook.php

   1 <?php
   2
   3 namespace MediaWiki\Api\Hook;
   4
   5 use MediaWiki\Request\WebRequest;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "RequestHasSameOriginSecurity" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface RequestHasSameOriginSecurityHook {
  15         /**
  16          * Use this hook to determine if the request is somehow flagged to lack same-origin security.
  17          * Note that if the "somehow" involves HTTP headers, you'll probably need to make sure
  18          * the header is varied on.
  19          *
  20          * @since 1.35
  21          *
  22          * @param WebRequest $request
  23          * @return bool|void True or no return value to continue, or false to indicate a lack of
  24          *   same-origin security
  25          */
  26         public function onRequestHasSameOriginSecurity( $request );
  27 }