MediaWiki REL1_40
Public Member Functions | List of all members
MediaWiki\Hook\SiteNoticeBeforeHook Interface Reference
Hooks

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onSiteNoticeBefore (&$siteNotice, $skin)
 This hook is called before the sitenotice/anonnotice is composed.
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "SiteNoticeBefore" to register handlers implementing this interface.

Stability: stable
to implement

Definition at line 14 of file SiteNoticeBeforeHook.php.

Member Function Documentation

◆ onSiteNoticeBefore()

MediaWiki\Hook\SiteNoticeBeforeHook::onSiteNoticeBefore ( & $siteNotice,
$skin )

This hook is called before the sitenotice/anonnotice is composed.

Since
1.35
Parameters
string&$siteNoticeHTML returned as the sitenotice
Skin$skin
Returns
bool|void True or no return value to continue or false to abort. Return true to allow the normal method of notice selection/rendering to work, or change the value of $siteNotice and return false to alter it.

Implemented in MediaWiki\HookContainer\HookRunner.

The documentation for this interface was generated from the following file: