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
27
28
29
30
31
32
33
34
35
36
|
<?php
namespace MediaWiki\Api\Hook;
use MediaWiki\Api\ApiBase;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Title\Title;
use Wikimedia\ScopedCallback;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ApiMakeParserOptions" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ApiMakeParserOptionsHook {
/**
* This hook is called from ApiParse and ApiExpandTemplates to allow
* extensions to adjust the ParserOptions before parsing.
*
* @since 1.35
*
* @param ParserOptions $options
* @param Title $title Title to be parsed
* @param array $params Parameter array for the API module
* @param ApiBase $module API module (which is also a ContextSource)
* @param ScopedCallback|null &$reset Set to a ScopedCallback used to reset any hooks after
* the parse is done
* @param bool &$suppressCache Set true if cache should be suppressed
* @return bool|void True or no return value to continue or false to abort
*/
public function onApiMakeParserOptions( $options, $title, $params, $module,
&$reset, &$suppressCache
);
}
|
