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

27 lines
797 B
PHP

<?php
namespace MediaWiki\Hook;
use Content;
use EditPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "EditPageGetPreviewContent" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface EditPageGetPreviewContentHook {
/**
* Use this hook to modify the wikitext that will be previewed. Note that it is preferable
* to implement previews for different data types using the ContentHandler facility.
*
* @since 1.35
*
* @param EditPage $editPage
* @param Content &$content Content object to be previewed (may be replaced by hook function)
* @return bool|void True or no return value to continue or false to abort
*/
public function onEditPageGetPreviewContent( $editPage, &$content );
}