wiki.techinc.nl/includes/Storage/Hook/ParserOutputStashForEditHook.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

31 lines
800 B
PHP

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