includes/api/Hook/ApiLogFeatureUsageHook.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 "ApiLogFeatureUsage" to register handlers implementing this interface.
   8  *
   9  * @stable to implement
  10  * @ingroup Hooks
  11  */
  12 interface ApiLogFeatureUsageHook {
  13         /**
  14          * This hook is called after calling the logFeatureUsage() method of an API module.
  15          * Use this hook to extend core API modules.
  16          *
  17          * @since 1.43
  18          *
  19          * @param string $feature
  20          * @param array<string,mixed> $clientInfo
  21          * @phan-param array{userName:string,userAgent:string,ipAddress:string} $clientInfo
  22          * @return void
  23          */
  24         public function onApiLogFeatureUsage( $feature, array $clientInfo ): void;
  25 }