MediaWiki  master
MediaWiki\Hook\OutputPageBodyAttributesHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\OutputPageBodyAttributesHook:

Public Member Functions

 onOutputPageBodyAttributes ( $out, $sk, &$bodyAttrs)
 This hook is called when OutputPage::headElement is creating the body tag to allow for extensions to add attributes to the body of the page they might need. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 15 of file OutputPageBodyAttributesHook.php.

Member Function Documentation

◆ onOutputPageBodyAttributes()

MediaWiki\Hook\OutputPageBodyAttributesHook::onOutputPageBodyAttributes (   $out,
  $sk,
$bodyAttrs 
)

This hook is called when OutputPage::headElement is creating the body tag to allow for extensions to add attributes to the body of the page they might need.

Or to allow building extensions to add body classes that aren't of high enough demand to be included in core.

Since
1.35
Parameters
OutputPage$outOutputPage which called the hook, can be used to get the real title
Skin$skSkin that called OutputPage::headElement
string[]&$bodyAttrsArray of attributes for the body tag passed to Html::openElement
Returns
void This hook must not abort, it must return no value

Implemented in MediaWiki\HookContainer\HookRunner.


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