MediaWiki\Api\Hook\ApiMakeParserOptionsHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\Api\ApiHookRunner.

Public Member Functions
	onApiMakeParserOptions ( $options, $title, $params, $module, &$reset, &$suppressCache)
	This hook is called from ApiParse and ApiExpandTemplates to allow extensions to adjust the ParserOptions before parsing.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "ApiMakeParserOptions" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 17 of file ApiMakeParserOptionsHook.php.

Member Function Documentation

onApiMakeParserOptions()

MediaWiki\Api\Hook\ApiMakeParserOptionsHook::onApiMakeParserOptions	(		$options,
			$title,
			$params,
			$module,
		&	$reset,
		&	$suppressCache )

This hook is called from ApiParse and ApiExpandTemplates to allow extensions to adjust the ParserOptions before parsing.

Since

1.35

Parameters

ParserOptions	$options
Title	$title	Title to be parsed
array	$params	Parameter array for the API module
ApiBase	$module	API module (which is also a ContextSource)
ScopedCallback | null	&$reset	Set to a ScopedCallback used to reset any hooks after the parse is done
bool	&$suppressCache	Set true if cache should be suppressed

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner.

---

The documentation for this interface was generated from the following file:

• includes/api/Hook/ApiMakeParserOptionsHook.php