includes/Hook/UserToolLinksEditHook.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 "UserToolLinksEdit" to register handlers implementing this interface.
   8  *
   9  * @stable to implement
  10  * @ingroup Hooks
  11  */
  12 interface UserToolLinksEditHook {
  13         /**
  14          * This hook is called when generating a list of user tool links, e.g.
  15          * "Foobar (Talk | Contribs | Block)".
  16          *
  17          * @since 1.35
  18          *
  19          * @param int $userId User ID of the current user
  20          * @param string $userText Username of the current user
  21          * @param string[] &$items Array of user tool links as HTML fragments
  22          * @return bool|void True or no return value to continue or false to abort
  23          */
  24         public function onUserToolLinksEdit( $userId, $userText, &$items );
  25 }