MediaWiki REL1_35
Public Member Functions | List of all members
MediaWiki\Hook\PostLoginRedirectHook Interface Reference
Hooks

Stable to implement. More...

Inheritance diagram for MediaWiki\Hook\PostLoginRedirectHook:
Inheritance graph
[legend]

Public Member Functions

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

Detailed Description

Stable to implement.

Definition at line 9 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&$returnToThe page name to return to, as a string
string[]&$returnToQueryArray of url parameters, mapping parameter names to values
string&$typeType 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: