MediaWiki master
MediaWiki\Hook\SpecialLogGetSubpagesForPrefixSearchHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onSpecialLogGetSubpagesForPrefixSearch (IContextSource $context, array &$subpages)
 Hook for intercepting and changing the list of suggested log types when typing "Special:Log" in the search box.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 15 of file SpecialLogGetSubpagesForPrefixSearchHook.php.

Member Function Documentation

◆ onSpecialLogGetSubpagesForPrefixSearch()

MediaWiki\Hook\SpecialLogGetSubpagesForPrefixSearchHook::onSpecialLogGetSubpagesForPrefixSearch ( IContextSource $context,
array & $subpages )

Hook for intercepting and changing the list of suggested log types when typing "Special:Log" in the search box.

The common use case for this hook is to include aliases for the log type in the suggestions.

Parameters
IContextSource$contextRequest context
string[]&$subpagesLog subpages currently known
Returns
void
Since
1.46

Implemented in MediaWiki\HookContainer\HookRunner.


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