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

27 lines
768 B
PHP

<?php
namespace MediaWiki\Api\Hook;
use WebRequest;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "RequestHasSameOriginSecurity" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface RequestHasSameOriginSecurityHook {
/**
* Use this hook to determine if the request is somehow flagged to lack same-origin security.
* Note that if the "somehow" involves HTTP headers, you'll probably need to make sure
* the header is varied on.
*
* @since 1.35
*
* @param WebRequest $request
* @return bool|void True or no return value to continue, or false to indicate a lack of
* same-origin security
*/
public function onRequestHasSameOriginSecurity( $request );
}