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

Public Member Functions
	onImageBeforeProduceHTML ( $unused, &$title, &$file, &$frameParams, &$handlerParams, &$time, &$res, $parser, &$query, &$widthOption)
	This hook is called before producing the HTML created by a wiki image insertion.

Detailed Description

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

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

Member Function Documentation

MediaWiki\Hook\ImageBeforeProduceHTMLHook::onImageBeforeProduceHTML	(		$unused,
		&	$title,
		&	$file,
		&	$frameParams,
		&	$handlerParams,
		&	$time,
		&	$res,
			$parser,
		&	$query,
		&	$widthOption )

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.

Parameters

null	$unused	Will always be null
Title	&$title	Title object of the image
File \| false	&$file	File object, or false if it doesn't exist
array	&$frameParams	Various parameters with special meanings; see documentation in includes/Linker.php for Linker::makeImageLink
array	&$handlerParams	Various parameters with special meanings; see documentation in includes/Linker.php for Linker::makeImageLink
string \| bool	&$time	Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
string	&$res	Final HTML output, used if you return false
Parser	$parser
string	&$query	Query params for desc URL
string	&$widthOption	Used by the parser to remember the user preference thumbnailsize

Returns: bool|void True or no return value to continue or false to skip the default logic

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