MediaWiki\SpecialPage\Hook\AuthChangeFormFieldsHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onAuthChangeFormFields ( $requests, $fieldInfo, &$formDescriptor, $action)
	This hook is called after converting a field information array obtained from a set of AuthenticationRequest classes into a form descriptor; hooks can tweak the array to change how login etc.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file AuthChangeFormFieldsHook.php.

Member Function Documentation

onAuthChangeFormFields()

MediaWiki\SpecialPage\Hook\AuthChangeFormFieldsHook::onAuthChangeFormFields	(		$requests,
			$fieldInfo,
		&	$formDescriptor,
			$action )

This hook is called after converting a field information array obtained from a set of AuthenticationRequest classes into a form descriptor; hooks can tweak the array to change how login etc.

forms should look.

Since

1.35

Parameters

AuthenticationRequest[]	$requests	Array of AuthenticationRequests the fields are created from
array	$fieldInfo	Field information array (union of all AuthenticationRequest::getFieldInfo() responses)
array	&$formDescriptor	HTMLForm descriptor. The special key 'weight' can be set to change the order of the fields.
string	$action	One of the AuthManager::ACTION_* constants

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/specialpage/Hook/AuthChangeFormFieldsHook.php