includes/skins/Hook/SkinAddFooterLinksHook.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 "SkinAddFooterLinks" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface SkinAddFooterLinksHook {
  15         /**
  16          * This hook is called when generating the code used to display the
  17          * footer.
  18          *
  19          * @since 1.35
  20          *
  21          * @param Skin $skin
  22          * @param string $key the current key for the current group (row) of footer links.
  23          *   e.g. `info` or `places`.
  24          * @param array &$footerItems an empty array that can be populated with new links.
  25          *   keys should be strings and will be used for generating the ID of the footer item
  26          *   and value should be an HTML string.
  27          * @return bool|void True or no return value to continue or false to abort
  28          */
  29         public function onSkinAddFooterLinks( Skin $skin, string $key, array &$footerItems );
  30 }