includes/skins/Hook/SkinTemplateGetLanguageLinkHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use MediaWiki\Output\OutputPage;
   6 use MediaWiki\Title\Title;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "SkinTemplateGetLanguageLink" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface SkinTemplateGetLanguageLinkHook {
  16         /**
  17          * This hook is called after building the data for a language link from
  18          * which the actual html is constructed.
  19          *
  20          * @since 1.35
  21          *
  22          * @param array &$languageLink Array containing data about the link. The following keys can be
  23          *   modified: href, text, title, class, lang, hreflang. Each of them is a string.
  24          * @param Title $languageLinkTitle Title object belonging to the external language link
  25          * @param Title $title Title object of the page the link belongs to
  26          * @param OutputPage $outputPage OutputPage object the links are built from
  27          * @return bool|void True or no return value to continue or false to abort
  28          */
  29         public function onSkinTemplateGetLanguageLink( &$languageLink,
  30                 $languageLinkTitle, $title, $outputPage
  31         );
  32 }