MediaWiki  master
MediaWiki\Hook\LanguageLinksHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\LanguageLinksHook:

Public Member Functions

 onLanguageLinks ( $title, &$links, &$linkFlags)
 Use this hook to manipulate a page's language links. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file LanguageLinksHook.php.

Member Function Documentation

◆ onLanguageLinks()

MediaWiki\Hook\LanguageLinksHook::onLanguageLinks (   $title,
$links,
$linkFlags 
)

Use this hook to manipulate a page's language links.

This hook is called in various places to allow extensions to define the effective language links for a page.

Since
1.35
Parameters
Title$title
string[]&$linksArray with elements of the form "language:title" in the order that they will be output
array&$linkFlagsAssociative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles.
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner, and MediaWiki\Api\ApiHookRunner.


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