wiki.techinc.nl/includes/Hook/EditPageGetPreviewContentHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

24 lines
645 B
PHP

<?php
namespace MediaWiki\Hook;
use Content;
use EditPage;
/**
* @stable for implementation
* @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 );
}