MediaWiki\Hook\UserLoginCompleteHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\UserLoginCompleteHook:

Public Member Functions
	onUserLoginComplete ( $user, &$inject_html, $direct)
	Use this hook to show custom content after a user has logged in via the web interface.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserLoginCompleteHook.php.

Member Function Documentation

onUserLoginComplete()

MediaWiki\Hook\UserLoginCompleteHook::onUserLoginComplete	(		$user,
		&	$inject_html,
			$direct )

Use this hook to show custom content after a user has logged in via the web interface.

For functionality that needs to run after any login (API or web) use UserLoggedIn.

Since

1.35

Parameters

User	$user	The user object that was created on login
string	&$inject_html	Any HTML to inject after the "logged in" message.
bool	$direct	(bool) The hook is called directly after a successful login. This will only happen once per login. A UserLoginComplete call with direct=false can happen when the user visits the login page while already logged in.

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/UserLoginCompleteHook.php