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

30 lines
873 B
PHP

<?php
namespace MediaWiki\Hook;
use File;
use Parser;
use Title;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ParserMakeImageParams" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ParserMakeImageParamsHook {
/**
* This hook is called before the parser generates an image link, use this
* to modify the parameters of the image.
*
* @since 1.35
*
* @param Title $title Title object representing the file
* @param File $file File object that will be used to create the image
* @param array &$params Two-dimensional array of parameters
* @param Parser $parser Parser object that called the hook
* @return bool|void True or no return value to continue or false to abort
*/
public function onParserMakeImageParams( $title, $file, &$params, $parser );
}