MediaWiki REL1_37
Public Member Functions | List of all members
MediaWiki\Page\Hook\ImagePageShowTOCHook Interface Reference
Hooks

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

Inheritance diagram for MediaWiki\Page\Hook\ImagePageShowTOCHook:
Inheritance graph
[legend]

Public Member Functions

 onImagePageShowTOC ( $page, &$toc)
 This hook is called when the file toc on an image page is generated.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 14 of file ImagePageShowTOCHook.php.

Member Function Documentation

◆ onImagePageShowTOC()

MediaWiki\Page\Hook\ImagePageShowTOCHook::onImagePageShowTOC (   $page,
&  $toc 
)

This hook is called when the file toc on an image page is generated.

Since
1.35
Parameters
ImagePage$page
string[]&$tocArray of <li> strings
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: