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

30 lines
1 KiB
PHP

<?php
namespace MediaWiki\Hook;
use OutputPage;
use Skin;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "OutputPageBodyAttributes" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface OutputPageBodyAttributesHook {
/**
* 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
*
* @param OutputPage $out OutputPage which called the hook, can be used to get the real title
* @param Skin $sk Skin that called OutputPage::headElement
* @param string[] &$bodyAttrs Array of attributes for the body tag passed to Html::openElement
* @return void This hook must not abort, it must return no value
*/
public function onOutputPageBodyAttributes( $out, $sk, &$bodyAttrs ): void;
}