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

33 lines
985 B
PHP

<?php
namespace MediaWiki\Hook;
use Content;
use EditPage;
use 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
);
}