wiki.techinc.nl/includes/page/Hook/ImagePageFindFileHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

29 lines
761 B
PHP

<?php
namespace MediaWiki\Page\Hook;
use File;
use ImagePage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ImagePageFindFile" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ImagePageFindFileHook {
/**
* This hook is called when fetching the file associated with an image
* page.
*
* @since 1.35
*
* @param ImagePage $page
* @param File|false &$file False on input, can be replaced with a File
* @param File|false &$displayFile False on input, can be replaced with a
* file to display.
* @return bool|void True or no return value to continue or false to abort
*/
public function onImagePageFindFile( $page, &$file, &$displayFile );
}