includes/api/Hook/ApiRsdServiceApisHook.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 "ApiRsdServiceApis" to register handlers implementing this interface.
   8  *
   9  * @stable to implement
  10  * @ingroup Hooks
  11  */
  12 interface ApiRsdServiceApisHook {
  13         /**
  14          * Use this hook to add or remove APIs from the RSD services list. Each service
  15          * should have its own entry in the $apis array and have a unique name, passed as
  16          * key for the array that represents the service data. In this data array, the
  17          * key-value-pair identified by the apiLink key is required.
  18          *
  19          * @since 1.35
  20          *
  21          * @param array &$apis Array of services
  22          * @return bool|void True or no return value to continue or false to abort
  23          */
  24         public function onApiRsdServiceApis( &$apis );
  25 }