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

29 lines
903 B
PHP

<?php
namespace MediaWiki\Diff\Hook;
use DifferenceEngine;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "DifferenceEngineLoadTextAfterNewContentIsLoaded" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface DifferenceEngineLoadTextAfterNewContentIsLoadedHook {
/**
* This hook is called in DifferenceEngine::loadText() after the new revision's content
* has been loaded into the class member variable $differenceEngine->mNewContent but before
* checking if the variable's value is null. Use this hook to inject content into said
* class member variable.
*
* @since 1.35
*
* @param DifferenceEngine $differenceEngine
* @return bool|void True or no return value to continue or false to abort
*/
public function onDifferenceEngineLoadTextAfterNewContentIsLoaded(
$differenceEngine
);
}