MediaWiki  master
Page\Hook\ArticleProtectHook Interface Reference

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

Inheritance diagram for Page\Hook\ArticleProtectHook:

Public Member Functions

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

Detailed Description

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

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

Stable to implement

Definition at line 15 of file ArticleProtectHook.php.

Member Function Documentation

◆ onArticleProtect()

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

This hook is called before an article is protected.

Since
1.35
Parameters
WikiPage$wikiPageWikiPage being protected
User$userUser doing the protection
array$protectSet of restriction keys
string$reasonReason 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: