aboutsummaryrefslogtreecommitdiffstats
path: root/includes/api/Hook/ApiRsdServiceApisHook.php
blob: 45871cd6cc438f7d1e0d31d0b21bcec1fd8e5cca (plain) (blame)
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 "ApiRsdServiceApis" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface ApiRsdServiceApisHook {
	/**
	 * Use this hook to add or remove APIs from the RSD services list. Each service
	 * should have its own entry in the $apis array and have a unique name, passed as
	 * key for the array that represents the service data. In this data array, the
	 * key-value-pair identified by the apiLink key is required.
	 *
	 * @since 1.35
	 *
	 * @param array &$apis Array of services
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onApiRsdServiceApis( &$apis );
}