Manual:Hooks/GetNewMessagesAlert

From Linux Web Expert

GetNewMessagesAlert
<translate> Available from <tvar name=1><translate> version <tvar (Gerrit change 62317)</tvar></translate>
Disable or modify the new messages alert before it is shown
<translate> Define function:</translate>
public static function onGetNewMessagesAlert( string &$newMessagesAlert, array $newtalks, User $user, OutputPage $out ) { ... }
<translate> Attach hook:</translate> <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
	"Hooks": {
		"GetNewMessagesAlert": "MediaWiki\\Extension\\MyExtension\\Hooks::onGetNewMessagesAlert"
	}
}
<translate> Called from:</translate> <translate> File(s):</translate> Skin.php
<translate> Interface:</translate> GetNewMessagesAlertHook.php

<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks </tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:GetNewMessagesAlert extensions</tvar>.</translate>


Details

  • &$newMessagesAlert - An empty string by default. If the user has new talk page messages, this should be populated with an alert message to that effect
  • $newtalks - An empty array if the user has no new messages or an array containing links and revisions if there are new messages (See User::getNewMessageLinks)
  • $user - The User object of the user who is loading the page
  • $out - OutputPage object (to check what type of page the user is on)

See also