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

24 lines
737 B
PHP

<?php
namespace MediaWiki\Hook;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "isValidEmailAddr" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface IsValidEmailAddrHook {
/**
* Use this hook to override the result of Sanitizer::validateEmail(), for
* instance to return false if the domain name doesn't match your organization.
*
* @since 1.35
*
* @param string $addr Email address entered by the user
* @param bool|null &$result Set this and return false to override the internal checks
* @return bool|void True or no return value to continue or false to abort
*/
public function onIsValidEmailAddr( $addr, &$result );
}