wiki.techinc.nl/includes/parser/Hook/ParserModifyImageHTMLHook.php
James D. Forrester 8e940c4f21 Standardise all our class alias deprecation comments for ease of grepping
Change-Id: I7f85d931d3b79da23e87b4e5692b2e14be8fcaa0
2024-03-19 20:11:29 +00:00

33 lines
1.1 KiB
PHP

<?php
namespace MediaWiki\Hook;
use File;
use MediaWiki\Parser\Parser;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ParserModifyImageHTML" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ParserModifyImageHTMLHook {
/**
* This hook is called for each image added to parser output, with its
* associated HTML as returned from Linker::makeImageLink().
*
* @param Parser $parser
* @param File $file
* @param array $params An associative array of options that were used to generate the HTML.
* Like the one sent to onParserMakeImageParams. The 'handler' element contains handler
* options. The 'frame' element contains frame options. In the image gallery case, "frame"
* will be missing.
* @param string &$html The HTML of the image or image wrapper
*/
public function onParserModifyImageHTML( Parser $parser, File $file,
array $params, string &$html ): void;
}
/** @deprecated class alias since 1.41 */
class_alias( ParserModifyImageHTMLHook::class, 'MediaWiki\Hook\ParserModifyImageHTML' );