SessionMetadataHook.php
No OneTemporary
Actions

Size

895 B

Referenced Files

None

Subscribers

None

SessionMetadataHook.php
View Options

	<?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
	* @ingroup Session
	*/
	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 );
	}