wiki.techinc.nl/includes/Hook/AlternateEditPreviewHook.php
James D. Forrester f7ce0a0976 Move remaining four classes in includes/content into Content namespace
Bug: T353458
Change-Id: Ia0f3e22078550be410c4b87faf6aa4eabe6e270d
2024-08-10 10:40:53 +02:00

33 lines
1 KiB
PHP

<?php
namespace MediaWiki\Hook;
use MediaWiki\Content\Content;
use MediaWiki\EditPage\EditPage;
use MediaWiki\Parser\ParserOutput;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "AlternateEditPreview" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface AlternateEditPreviewHook {
/**
* This hook is called before generating the preview of the page when editing
* ( EditPage::getPreviewText() ).
*
* @since 1.35
*
* @param EditPage $editPage
* @param Content &$content Content object for the text field from the edit page
* @param string &$previewHTML Text to be placed into the page for the preview
* @param ParserOutput &$parserOutput ParserOutput object for the preview
* @return bool|void True or no return value to continue, or false and set $previewHTML and
* $parserOutput to output custom page preview HTML
*/
public function onAlternateEditPreview( $editPage, &$content, &$previewHTML,
&$parserOutput
);
}