MediaWiki\Page\Hook\ArticleProtectHook Interface Reference

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

Inheritance diagram for MediaWiki\Page\Hook\ArticleProtectHook:

Public Member Functions
	onArticleProtect ( $wikiPage, $user, $protect, $reason)
	This hook is called before an article is protected.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 of file ArticleProtectHook.php.

Member Function Documentation

onArticleProtect()

MediaWiki\Page\Hook\ArticleProtectHook::onArticleProtect	(		$wikiPage,
			$user,
			$protect,
			$reason
	)

This hook is called before an article is protected.

Since

1.35

Parameters

WikiPage	$wikiPage	WikiPage being protected
User	$user	User doing the protection
array	$protect	Set of restriction keys
string	$reason	Reason for protect

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