includes/page/Hook/ArticleProtectHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use MediaWiki\User\User;
   6 use WikiPage;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "ArticleProtect" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface ArticleProtectHook {
  16         /**
  17          * This hook is called before an article is protected.
  18          *
  19          * @since 1.35
  20          *
  21          * @param WikiPage $wikiPage WikiPage being protected
  22          * @param User $user User doing the protection
  23          * @param array $protect Set of restriction keys
  24          * @param string $reason Reason for protect
  25          * @return bool|void True or no return value to continue or false to abort
  26          */
  27         public function onArticleProtect( $wikiPage, $user, $protect, $reason );
  28 }