MediaWiki\Session\Hook\SessionMetadataHook Interface Reference

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

Inheritance diagram for MediaWiki\Session\Hook\SessionMetadataHook:

Public Member Functions
	onSessionMetadata ( $backend, &$metadata, $requests)
	Use this hook to add metadata to a session being saved.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 of file SessionMetadataHook.php.

Member Function Documentation

onSessionMetadata()

MediaWiki\Session\Hook\SessionMetadataHook::onSessionMetadata	(		$backend,
		&	$metadata,
			$requests
	)

Use this hook to add metadata to a session being saved.

Since

1.35

Parameters

SessionBackend	$backend	MediaWiki\Session\SessionBackend being saved
array	&$metadata	Metadata to be stored. Add new keys here.
WebRequest[]	$requests	Array of WebRequests potentially being saved to. Generally 0-1 real request and 0+ FauxRequests.

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/session/Hook/SessionMetadataHook.php