Open main menu

Manual:Hooks/AbortNewAccount

< Manual:Hooks
AbortNewAccount
Available from version 1.5.8
Can be used to cancel user account creation
Define function:
public static function onAbortNewAccount( $user, &$message ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"AbortNewAccount": "MyExtensionHooks::onAbortNewAccount"
	}
}

For MediaWiki ≤1.25:

$wgHooks['AbortNewAccount'][] = 'MyExtensionHooks::onAbortNewAccount';
Called from:File(s): SpecialUserlogin.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:AbortNewAccount extensions.

DetailsEdit

  • $user: the User object about to be created (read-only, incomplete)
  • $message: out parameter: error message to display on abort

NotesEdit

  • Return false to cancel account creation.

DeprecatedEdit

In MediaWiki 1.27, the hook was deprecated and superseded by AuthManager functionality. It was removed in MediaWiki 1.33. Any logic in it must be moved to a class implementing PreAuthenticationProvider, into the testForAccountCreation and testUserForCreation methods.