includes/api/Hook/APIGetParamDescriptionMessagesHook.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
26

<?php

namespace MediaWiki\Api\Hook;

use MediaWiki\Api\ApiBase;
use MediaWiki\Message\Message;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "APIGetParamDescriptionMessages" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface APIGetParamDescriptionMessagesHook {
	/**
	 * Use this hook to modify a module's parameter descriptions.
	 *
	 * @since 1.35
	 *
	 * @param ApiBase $module
	 * @param Message[][] &$msg
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onAPIGetParamDescriptionMessages( $module, &$msg );
}