wiki.techinc.nl/includes/page/Hook/WikiPageDeletionUpdatesHook.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

30 lines
893 B
PHP

<?php
namespace MediaWiki\Page\Hook;
use Content;
use DeferrableUpdate;
use WikiPage;
/**
* @deprecated since 1.32 Use PageDeletionDataUpdates or override
* ContentHandler::getDeletionDataUpdates instead
* @ingroup Hooks
*/
interface WikiPageDeletionUpdatesHook {
/**
* Use this hook to manipulate the list of DeferrableUpdates to be applied
* when a page is deleted.
*
* @since 1.35
*
* @param WikiPage $page
* @param Content|null $content Content to generate updates for, or null in
* case the page revision could not be loaded. The delete will succeed
* despite this.
* @param DeferrableUpdate[] &$updates Array of objects that implement
* DeferrableUpdate. Hook function may want to add to it.
* @return bool|void True or no return value to continue or false to abort
*/
public function onWikiPageDeletionUpdates( $page, $content, &$updates );
}