includes/actions/Hook/UnwatchArticleHook.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

<?php

namespace MediaWiki\Hook;

use MediaWiki\Page\WikiPage;
use MediaWiki\Status\Status;
use MediaWiki\User\User;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "UnwatchArticle" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface UnwatchArticleHook {
	/**
	 * This hook is called before a watch is removed from an article.
	 *
	 * @since 1.35
	 *
	 * @param User $user User watching
	 * @param WikiPage $page WikiPage object to be removed
	 * @param Status &$status Status object to be returned if the hook returns false
	 * @return bool|void True or no return value to continue or false to abort and
	 *   return Status object
	 */
	public function onUnwatchArticle( $user, $page, &$status );
}