wiki.techinc.nl/includes/parser/Hook/IsValidEmailAddrHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

23 lines
617 B
PHP

<?php
namespace MediaWiki\Hook;
use MailAddress;
/**
* @stable for implementation
* @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 MailAddress $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 );
}