wiki.techinc.nl/includes/changes/Hook/MarkPatrolledCompleteHook.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

27 lines
724 B
PHP

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