MediaWiki  master
MediaWiki\Session\Hook\SessionCheckInfoHook Interface Reference

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

Inheritance diagram for MediaWiki\Session\Hook\SessionCheckInfoHook:

Public Member Functions

 onSessionCheckInfo (&$reason, $info, $request, $metadata, $data)
 Use this hook to validate a MediaWiki\Session\SessionInfo as it's being loaded from storage. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 15 of file SessionCheckInfoHook.php.

Member Function Documentation

◆ onSessionCheckInfo()

MediaWiki\Session\Hook\SessionCheckInfoHook::onSessionCheckInfo ( $reason,
  $info,
  $request,
  $metadata,
  $data 
)

Use this hook to validate a MediaWiki\Session\SessionInfo as it's being loaded from storage.

Since
1.35
Parameters
string&$reasonRejection reason to be logged
SessionInfo$infoMediaWiki\Session\SessionInfo being validated
WebRequest$requestWebRequest being loaded from
array | bool$metadataMetadata array for the MediaWiki\Session\Session
array | bool$dataData array for the MediaWiki\Session\Session
Returns
bool|void True or no return value to continue, or false to prevent the MediaWiki\Session\SessionInfo from being used

Implemented in MediaWiki\HookContainer\HookRunner.


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