MediaWiki\Hook\UnwatchArticleHook Interface Reference
This is a hook handler interface, see docs/Hooks.md. More...
Inheritance diagram for MediaWiki\Hook\UnwatchArticleHook:
Public Member Functions | |
| onUnwatchArticle ( $user, $page, &$status) | |
| This hook is called before a watch is removed from an article. | |
Detailed Description
This is a hook handler interface, see docs/Hooks.md.
Use the hook name "UnwatchArticle" to register handlers implementing this interface.
- Stability: stable
- to implement
Definition at line 16 of file UnwatchArticleHook.php.
Member Function Documentation
◆ onUnwatchArticle()
| MediaWiki\Hook\UnwatchArticleHook::onUnwatchArticle | ( | $user, | |
| $page, | |||
| & | $status | ||
| ) |
This hook is called before a watch is removed from an article.
- Since
- 1.35
- Parameters
-
User $user User watching WikiPage $page WikiPage object to be removed Status &$status Status object to be returned if the hook returns false
- Returns
- bool|void True or no return value to continue or false to abort and return Status object
Implemented in MediaWiki\HookContainer\HookRunner.
The documentation for this interface was generated from the following file:
- includes/actions/Hook/UnwatchArticleHook.php
