includes/skins/Hook/SiteNoticeBeforeHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use Skin;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "SiteNoticeBefore" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface SiteNoticeBeforeHook {
  15         /**
  16          * This hook is called before the sitenotice/anonnotice is composed.
  17          *
  18          * @since 1.35
  19          *
  20          * @param string &$siteNotice HTML returned as the sitenotice
  21          * @param Skin $skin
  22          * @return bool|void True or no return value to continue or false to abort.
  23          *   Return true to allow the normal method of notice selection/rendering to work,
  24          *   or change the value of $siteNotice and return false to alter it.
  25          */
  26         public function onSiteNoticeBefore( &$siteNotice, $skin );
  27 }