MediaWiki\Hook\UserLogoutCompleteHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\UserLogoutCompleteHook:

Public Member Functions
	onUserLogoutComplete ( $user, &$inject_html, $oldName)
	This hook is called after a user has logged out.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserLogoutCompleteHook.php.

Member Function Documentation

onUserLogoutComplete()

MediaWiki\Hook\UserLogoutCompleteHook::onUserLogoutComplete	(		$user,
		&	$inject_html,
			$oldName
	)

This hook is called after a user has logged out.

Since

1.35

Parameters

User	$user	the user object after logout (won't have name, ID, etc.)
string	&$inject_html	Any HTML to inject after the "logged out" message.
string	$oldName	name of the user before logout (string)

Returns

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

Implemented in MediaWiki\Api\ApiHookRunner, and MediaWiki\HookContainer\HookRunner.

---

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

• includes/specials/Hook/UserLogoutCompleteHook.php