MediaWiki  master
MediaWiki\Api\Hook\ApiMakeParserOptionsHook Interface Reference

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

Inheritance diagram for MediaWiki\Api\Hook\ApiMakeParserOptionsHook:

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. More...
 

Detailed Description

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

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

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$titleTitle to be parsed
array$paramsParameter array for the API module
ApiBase$moduleAPI module (which is also a ContextSource)
ScopedCallback | null&$resetSet to a ScopedCallback used to reset any hooks after the parse is done
bool&$suppressCacheSet 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: