5bd33d46ef
This has been approved as part of RFC T166010 Bug: T321882 Change-Id: I6bbdbbe6ea48cc1f50bc568bb8780fc7c5361a6f
28 lines
875 B
PHP
28 lines
875 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Session\Hook;
|
|
|
|
use MediaWiki\Request\WebRequest;
|
|
use MediaWiki\Session\SessionBackend;
|
|
|
|
/**
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
* Use the hook name "SessionMetadata" to register handlers implementing this interface.
|
|
*
|
|
* @stable to implement
|
|
* @ingroup Hooks
|
|
*/
|
|
interface SessionMetadataHook {
|
|
/**
|
|
* Use this hook to add metadata to a session being saved.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param SessionBackend $backend MediaWiki\Session\SessionBackend being saved
|
|
* @param array &$metadata Metadata to be stored. Add new keys here.
|
|
* @param WebRequest[] $requests Array of WebRequests potentially being
|
|
* saved to. Generally 0-1 real request and 0+ FauxRequests.
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onSessionMetadata( $backend, &$metadata, $requests );
|
|
}
|