includes/specialpage/Hook/ChangeAuthenticationDataAuditHook.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

<?php

namespace MediaWiki\SpecialPage\Hook;

use MediaWiki\Auth\AuthenticationRequest;
use StatusValue;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "ChangeAuthenticationDataAudit" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface ChangeAuthenticationDataAuditHook {
	/**
	 * This hook is called when a user changes their password.
	 * No return data is accepted; this hook is for auditing only.
	 *
	 * @since 1.35
	 *
	 * @param AuthenticationRequest $req Object describing the change (and target user)
	 * @param StatusValue $status StatusValue with the result of the action
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onChangeAuthenticationDataAudit( $req, $status );
}