includes/api/Hook/ApiQueryTokensRegisterTypesHook.php

   1 <?php
   2
   3 namespace MediaWiki\Api\Hook;
   4
   5 /**
   6  * This is a hook handler interface, see docs/Hooks.md.
   7  * Use the hook name "ApiQueryTokensRegisterTypes" to register handlers implementing this interface.
   8  *
   9  * @stable to implement
  10  * @ingroup Hooks
  11  */
  12 interface ApiQueryTokensRegisterTypesHook {
  13         /**
  14          * Use this hook to add additional token types to action=query&meta=tokens.
  15          * Note that most modules will probably be able to use the CSRF token
  16          * instead of creating their own token types.
  17          *
  18          * @since 1.35
  19          *
  20          * @param array &$salts [ type => salt to pass to User::getEditToken(), or array of salt
  21          *   and key to pass to Session::getToken() ]
  22          * @return bool|void True or no return value to continue or false to abort
  23          */
  24         public function onApiQueryTokensRegisterTypes( &$salts );
  25 }