MediaWiki\Auth\Hook\AuthPreserveQueryParamsHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onAuthPreserveQueryParams (array &$params, array $options)
	This hook gets called any time an authentication page generates an URL which is in some sense part of the authentication process (e.g.

Detailed Description

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

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

Stability: unstable

to implement

Definition at line 12 of file AuthPreserveQueryParamsHook.php.

Member Function Documentation

onAuthPreserveQueryParams()

MediaWiki\Auth\Hook\AuthPreserveQueryParamsHook::onAuthPreserveQueryParams	(	array &	$params,
		array	$options )

This hook gets called any time an authentication page generates an URL which is in some sense part of the authentication process (e.g.

a language switcher link, the login form's action URL, or the return URL for a remote identity provider) and needs to determine which of the current query parameters to preserve in that URL.

Since

1.43

Parameters

array	&$params	Query parameters to preserve, name => value
array	$options	Information about the purpose of the URL that's being generated reset (bool, default false): Reset the authentication process, i.e. omit parameters which are related to continuing in-progress authentication. This is used e.g. in the link for switching from the login form to the signup form.

Returns

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

---

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

• includes/auth/Hook/AuthPreserveQueryParamsHook.php