MediaWiki REL1_37
MediaWiki\Page\Hook\ImagePageFindFileHook Interface Reference

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

Inheritance diagram for MediaWiki\Page\Hook\ImagePageFindFileHook:

Public Member Functions

 onImagePageFindFile ( $page, &$file, &$displayFile)
 This hook is called when fetching the file associated with an image page.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 15 of file ImagePageFindFileHook.php.

Member Function Documentation

◆ onImagePageFindFile()

MediaWiki\Page\Hook\ImagePageFindFileHook::onImagePageFindFile (   $page,
$file,
$displayFile 
)

This hook is called when fetching the file associated with an image page.

Since
1.35
Parameters
ImagePage$page
File | false&$fileFalse on input, can be replaced with a File
File | false&$displayFileFalse on input, can be replaced with a file to display.
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: