MediaWiki\Hook\PostLoginRedirectHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\PostLoginRedirectHook:

Public Member Functions
	onPostLoginRedirect (&$returnTo, &$returnToQuery, &$type)
	Use this hook to modify the post login redirect behavior.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 12 of file PostLoginRedirectHook.php.

Member Function Documentation

onPostLoginRedirect()

MediaWiki\Hook\PostLoginRedirectHook::onPostLoginRedirect	(	&	$returnTo,
		&	$returnToQuery,
		&	$type )

Use this hook to modify the post login redirect behavior.

Occurs after signing up or logging in, allows for interception of redirect.

Since

1.35

Parameters

string	&$returnTo	The page name to return to, as a string
string[]	&$returnToQuery	Array of url parameters, mapping parameter names to values
string	&$type	Type of login redirect as string: error: display a return to link ignoring $wgRedirectOnLogin signup: display a return to link using $wgRedirectOnLogin if needed success: display a return to link using $wgRedirectOnLogin if needed successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed

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/specials/Hook/PostLoginRedirectHook.php