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

28 lines
728 B
PHP

<?php
namespace MediaWiki\Page\Hook;
use User;
use WikiPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "PageViewUpdates" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface PageViewUpdatesHook {
/**
* Use this hook to make database (or other) changes after a
* page view is seen by MediaWiki. Note this does not capture views made
* via external caches such as Squid.
*
* @since 1.35
*
* @param WikiPage $wikipage Page being viewed
* @param User $user User who is viewing
* @return bool|void True or no return value to continue or false to abort
*/
public function onPageViewUpdates( $wikipage, $user );
}