MediaWiki\Hook\IsValidEmailAddrHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\IsValidEmailAddrHook:

Public Member Functions
	onIsValidEmailAddr ( $addr, &$result)
	Use this hook to override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 12 of file IsValidEmailAddrHook.php.

Member Function Documentation

onIsValidEmailAddr()

MediaWiki\Hook\IsValidEmailAddrHook::onIsValidEmailAddr	(		$addr,
		&	$result
	)

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

Parameters

string	$addr	Email address entered by the user
bool | null	&$result	Set this and return false to override the internal checks

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/parser/Hook/IsValidEmailAddrHook.php