MediaWiki  master
MediaWiki\Hook\WatchlistEditorBeforeFormRenderHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\WatchlistEditorBeforeFormRenderHook:

Public Member Functions

 onWatchlistEditorBeforeFormRender (&$watchlistInfo)
 This hook is called before building the Special:EditWatchlist form. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 12 of file WatchlistEditorBeforeFormRenderHook.php.

Member Function Documentation

◆ onWatchlistEditorBeforeFormRender()

MediaWiki\Hook\WatchlistEditorBeforeFormRenderHook::onWatchlistEditorBeforeFormRender ( $watchlistInfo)

This hook is called before building the Special:EditWatchlist form.

It is used to manipulate the list of pages or preload data based on that list.

Since
1.35
Parameters
array&$watchlistInfoArray of watchlisted pages in [namespaceId => ['title1' => 1, 'title2' => 1]] format
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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