| AuthPreserveQueryParams | |
|---|---|
| Available fromversion 1.43.0 Used when an authentication page generates an URL which is in some sense part of the authentication process | |
| Define function: | publicstaticfunctiononAuthPreserveQueryParams(array&$params,array$options){...} |
| Attach hook: | Inextension.json:{"Hooks":{"AuthPreserveQueryParams":"MediaWiki\\Extension\\MyExtension\\Hooks::onAuthPreserveQueryParams"}} |
| Called from: | File(s):specialpage/AuthManagerSpecialPage.php,skins/components/SkinComponentUtils.php |
| Interface: | AuthPreserveQueryParamsHook.php |
For more information about attaching hooks, seeManual:Hooks.
For examples of extensions using this hook, seeCategory:AuthPreserveQueryParams extensions.
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.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.