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

31 lines
1.1 KiB
PHP

<?php
namespace MediaWiki\Content\Hook;
use Content;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ConvertContent" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ConvertContentHook {
/**
* This hook is called by AbstractContent::convert when a conversion to another content model
* is requested. Handler functions that modify $result should generally return false to disable
* further attempts at conversion.
*
* @since 1.35
*
* @param Content $content Content object to be converted
* @param string $toModel ID of the content model to convert to
* @param bool $lossy Whether lossy conversion is allowed
* @param Content|bool &$result Output parameter, in case the handler function wants to
* provide a converted Content object. Note that $result->getContentModel() must return
* $toModel.
* @return bool|void True or no return value to continue or false to abort
*/
public function onConvertContent( $content, $toModel, $lossy, &$result );
}