File: RenameUserWarningHook.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (29 lines) | stat: -rw-r--r-- 955 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<?php

namespace MediaWiki\RenameUser\Hook;

/**
 * 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.
 *
 * @stable to implement
 * @ingroup Hooks
 * @since 1.40
 */
interface RenameUserWarningHook {

	/**
	 * Called on Special:Renameuser before a user is renamed.
	 * Will show the given warnings to the user and ask for a confirmation.
	 *
	 * @param string $oldUsername The old username as a page title.
	 * @param string $newUsername The new username as a page title.
	 * @param array &$warnings An array with 1 or more message keys, and 1 or more parameters
	 * for the warnings to be shown
	 */
	public function onRenameUserWarning( string $oldUsername, string $newUsername, array &$warnings ): void;

}