includes/Hook/LinkerMakeExternalLinkHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 /**
   6  * This is a hook handler interface, see docs/Hooks.md.
   7  * Use the hook name "LinkerMakeExternalLink" to register handlers implementing this interface.
   8  *
   9  * @stable to implement
  10  * @ingroup Hooks
  11  */
  12 interface LinkerMakeExternalLinkHook {
  13         /**
  14          * This hook is called at the end of Linker::makeExternalLink() just before the return.
  15          *
  16          * @since 1.35
  17          *
  18          * @param string &$url Link URL
  19          * @param string &$text Link text
  20          * @param string &$link New link HTML (if returning false)
  21          * @param string[] &$attribs Attributes to be applied
  22          * @param string $linkType External link type
  23          * @return bool|void True or no return value to continue or false to abort
  24          */
  25         public function onLinkerMakeExternalLink( &$url, &$text, &$link, &$attribs,
  26                 $linkType
  27         );
  28 }