MediaWiki  master
MediaWiki\Api\Hook\RequestHasSameOriginSecurityHook Interface Reference

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

Inheritance diagram for MediaWiki\Api\Hook\RequestHasSameOriginSecurityHook:

Public Member Functions

 onRequestHasSameOriginSecurity ( $request)
 Use this hook to determine if the request is somehow flagged to lack same-origin security. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file RequestHasSameOriginSecurityHook.php.

Member Function Documentation

◆ onRequestHasSameOriginSecurity()

MediaWiki\Api\Hook\RequestHasSameOriginSecurityHook::onRequestHasSameOriginSecurity (   $request)

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
Parameters
WebRequest$request
Returns
bool|void True or no return value to continue, or false to indicate a lack of same-origin security

Implemented in MediaWiki\Api\ApiHookRunner.


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