includes/skins/Hook/SkinCopyrightFooterMessageHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use MediaWiki\Title\Title;
   6 use Wikimedia\Message\MessageSpecifier;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "SkinCopyrightFooterMessage" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface SkinCopyrightFooterMessageHook {
  16         /**
  17          * Use this hook for site and per-namespace customization of the copyright notice as wikitext.
  18          *
  19          * @since 1.43
  20          *
  21          * @param Title $title Displayed page title
  22          * @param string $type Set to 'normal' or 'history' for old/diff views
  23          * @param MessageSpecifier &$msg Overridable message.
  24          *   The default key is 'copyright-footer' or 'copyright-footer-history' for old/diff views,
  25          *   with a link the license as the first parameter. The message will be displayed with parse().
  26          * @return bool|void True or no return value to continue or false to abort
  27          */
  28         public function onSkinCopyrightFooterMessage( $title, $type, &$msg );
  29 }