wiki.techinc.nl/includes/Hook/ImageBeforeProduceHTMLHook.php
C. Scott Ananian ab660966d2 Remove deprecated Linker methods
The removed tests in LinkerTest were ported (or were previously
ported) to the new CommentFormatter framework in the CommentParserTest
class; some references to the LinkerTest class have been removed since
CommentParserTest is now the canonical location for these.

Cleaned up a bit more from the removed DummyLinker class as well
(I69689b2037269af3320b6203fc44755f93713489).

Followup-To: I69689b2037269af3320b6203fc44755f93713489
Change-Id: Ia743d13c4fe7f4e3e2bd11274895a261adbfd8e2
2024-05-15 15:18:07 +00:00

42 lines
1.6 KiB
PHP

<?php
namespace MediaWiki\Hook;
use File;
use MediaWiki\Parser\Parser;
use MediaWiki\Title\Title;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ImageBeforeProduceHTML" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ImageBeforeProduceHTMLHook {
/**
* This hook is called before producing the HTML created by a wiki image insertion.
* You can skip the default logic entirely by returning false, or just modify a few
* things using call-by-reference.
*
* @since 1.35
*
* @param null $unused Will always be null
* @param Title &$title Title object of the image
* @param File|false &$file File object, or false if it doesn't exist
* @param array &$frameParams Various parameters with special meanings; see documentation in
* includes/Linker.php for Linker::makeImageLink
* @param array &$handlerParams Various parameters with special meanings; see documentation in
* includes/Linker.php for Linker::makeImageLink
* @param string|bool &$time Timestamp of file in 'YYYYMMDDHHIISS' string
* form, or false for current
* @param string &$res Final HTML output, used if you return false
* @param Parser $parser
* @param string &$query Query params for desc URL
* @param string &$widthOption Used by the parser to remember the user preference thumbnailsize
* @return bool|void True or no return value to continue or false to skip the default logic
*/
public function onImageBeforeProduceHTML( $unused, &$title, &$file,
&$frameParams, &$handlerParams, &$time, &$res, $parser, &$query, &$widthOption
);
}