MediaWiki master
MediaWiki\Hook\SkinEditSectionLinksHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onSkinEditSectionLinks ( $skin, $title, $section, $sectionTitle, &$result, $lang)
 Use this hook to modify section edit links.

Detailed Description

This is a hook handler interface, see docs/

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

Stability: stable
to implement

Definition at line 16 of file SkinEditSectionLinksHook.php.

Member Function Documentation

◆ onSkinEditSectionLinks()

MediaWiki\Hook\SkinEditSectionLinksHook::onSkinEditSectionLinks ( $skin,
& $result,
$lang )

Use this hook to modify section edit links.

Skin$skinSkin object rendering the UI
Title$titleTitle being linked to (may not be the same as the page title, if the section is included from a template)
string$sectionDesignation of the section being pointed to, to be included in the link, like "&section=$section"
string$sectionTitleSection title, used in the default tooltip. Escape before using. By default, this is wrapped in the 'editsectionhint' message.
array&$resultArray containing all link detail arrays. Each link detail array should contain the following keys:
  • targetTitle: Target Title object
  • text: String for the text
  • attribs: Array of attributes
  • query: Array of query parameters to add to the URL
Language$langLanguage to use for the link in the wfMessage function
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

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