MediaWiki  master
MediaWiki\SpecialPage\Hook\SpecialPageBeforeExecuteHook Interface Reference

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

Inheritance diagram for MediaWiki\SpecialPage\Hook\SpecialPageBeforeExecuteHook:

Public Member Functions

 onSpecialPageBeforeExecute ( $special, $subPage)
 This hook is called before SpecialPage::execute. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file SpecialPageBeforeExecuteHook.php.

Member Function Documentation

◆ onSpecialPageBeforeExecute()

MediaWiki\SpecialPage\Hook\SpecialPageBeforeExecuteHook::onSpecialPageBeforeExecute (   $special,
  $subPage 
)

This hook is called before SpecialPage::execute.

Since
1.35
Parameters
SpecialPage$special
string | null$subPageSubpage string, or null if no subpage was specified
Returns
bool|void True or no return value to continue or false to prevent execution

Implemented in MediaWiki\HookContainer\HookRunner.


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