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

30 lines
872 B
PHP

<?php
namespace MediaWiki\Hook;
use User;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "MarkPatrolledComplete" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface MarkPatrolledCompleteHook {
/**
* This hook is called after an edit is marked patrolled.
*
* @since 1.35
*
* @param int $rcid ID of the revision marked as patrolled
* @param User $user User who marked the edit patrolled
* @param bool $wcOnlySysopsCanPatrol Config setting indicating whether the user must be a
* sysop to patrol the edit
* @param bool $auto True if the edit is being marked as patrolled automatically
* @return bool|void True or no return value to continue or false to abort
*/
public function onMarkPatrolledComplete( $rcid, $user, $wcOnlySysopsCanPatrol,
$auto
);
}