MediaWiki\Hook\ProtectionForm__saveHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\ProtectionForm__saveHook:

Public Member Functions
	onProtectionForm__save ( $article, &$errorMsg, $reasonstr)
	This hook is called when a protection form is submitted.

Detailed Description

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

Use the hook name "ProtectionForm::save" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 15 of file ProtectionForm__saveHook.php.

Member Function Documentation

onProtectionForm__save()

MediaWiki\Hook\ProtectionForm__saveHook::onProtectionForm__save	(		$article,
		&	$errorMsg,
			$reasonstr
	)

This hook is called when a protection form is submitted.

Since

1.35

Parameters

Article	$article	Page being (un)protected
string | array	&$errorMsg	HTML message string of an error or an array of message name and its parameters
string	$reasonstr	String describing the reason page protection level is altered

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/Hook/ProtectionForm__saveHook.php