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

25 lines
782 B
PHP

<?php
namespace MediaWiki\User\Hook;
use MediaWiki\User\UserIdentity;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "UserClearNewTalkNotification" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface UserClearNewTalkNotificationHook {
/**
* This hook is called before clearing the "You have new messages!" message.
*
* @since 1.35
*
* @param UserIdentity $userIdentity User that will clear the message
* @param int $oldid ID of the talk page revision being viewed (0 means the most recent one)
* @return bool|void True or no return value to continue or false to abort (not clear the message)
*/
public function onUserClearNewTalkNotification( $userIdentity, $oldid );
}