wiki.techinc.nl/includes/user/Hook/IsValidPasswordHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

28 lines
785 B
PHP

<?php
namespace MediaWiki\User\Hook;
use MessageSpecifier;
use User;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "isValidPassword" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface IsValidPasswordHook {
/**
* Use this hook to override the result of User::isValidPassword()
*
* @since 1.35
*
* @param string $password The password entered by the user
* @param bool|string|MessageSpecifier &$result Set this and return false
* to override the internal checks
* @param User $user User the password is being validated for
* @return bool|void True or no return value to continue or false to abort
*/
public function onIsValidPassword( $password, &$result, $user );
}