MediaWiki\RenameUser\Hook\RenameUserWarningHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onRenameUserWarning (string $oldUsername, string $newUsername, array &$warnings)
	Called on Special:Renameuser before a user is renamed.

Detailed Description

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

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

Between MediaWiki 1.36 and 1.39, this interface was part of the Renameuser extension, with the namespace MediaWiki\Extension\Renameuser\Hook.

Stability: stable

to implement

Since

1.40

Definition at line 16 of file RenameUserWarningHook.php.

Member Function Documentation

onRenameUserWarning()

MediaWiki\RenameUser\Hook\RenameUserWarningHook::onRenameUserWarning	(	string	$oldUsername,
		string	$newUsername,
		array &	$warnings )

Called on Special:Renameuser before a user is renamed.

Will show the given warnings to the user and ask for a confirmation.

Parameters

string	$oldUsername	The old username as a page title.
string	$newUsername	The new username as a page title.
array	&$warnings	An array with 1 or more message keys, and 1 or more parameters for the warnings to be shown

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/RenameUser/Hook/RenameUserWarningHook.php