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

34 lines
951 B
PHP

<?php
namespace MediaWiki\Storage\Hook;
use Content;
use ParserOutput;
use User;
use WikiPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ParserOutputStashForEdit" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ParserOutputStashForEditHook {
/**
* This hook is called when an edit stash parse finishes, before the
* output is cached.
*
* @since 1.35
*
* @param WikiPage $page WikiPage of the candidate edit
* @param Content $content Content object of the candidate edit
* @param ParserOutput $output ParserOutput result of the candidate edit
* @param string $summary Change summary of the candidate edit
* @param User $user User considering the edit
* @return bool|void True or no return value to continue or false to abort
*/
public function onParserOutputStashForEdit( $page, $content, $output, $summary,
$user
);
}