includes/api/Hook/ApiLogFeatureUsageHook.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

<?php

namespace MediaWiki\Api\Hook;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "ApiLogFeatureUsage" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface ApiLogFeatureUsageHook {
	/**
	 * This hook is called after calling the logFeatureUsage() method of an API module.
	 * Use this hook to extend core API modules.
	 *
	 * @since 1.43
	 *
	 * @param string $feature
	 * @param array<string,mixed> $clientInfo
	 * @phan-param array{userName:string,userAgent:string,ipAddress:string} $clientInfo
	 * @return void
	 */
	public function onApiLogFeatureUsage( $feature, array $clientInfo ): void;
}