MediaWiki master
MediaWiki\SpecialPage\Hook\ChangeAuthenticationDataAuditHook Interface Reference

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

Inherited by MediaWiki\Api\ApiHookRunner, and MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onChangeAuthenticationDataAudit ( $req, $status)
 This hook is called when a user changes their password.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 15 of file ChangeAuthenticationDataAuditHook.php.

Member Function Documentation

◆ onChangeAuthenticationDataAudit()

MediaWiki\SpecialPage\Hook\ChangeAuthenticationDataAuditHook::onChangeAuthenticationDataAudit (   $req,
  $status 
)

This hook is called when a user changes their password.

No return data is accepted; this hook is for auditing only.

Since
1.35
Parameters
AuthenticationRequest$reqObject describing the change (and target user)
StatusValue$statusStatusValue with the result of the action
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner, and MediaWiki\HookContainer\HookRunner.


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