MediaWiki  master
MediaWiki\Hook\GetDefaultSortkeyHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\GetDefaultSortkeyHook:

Public Member Functions

 onGetDefaultSortkey ( $title, &$sortkey)
 Use this hook to override the default sortkey for a page. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file GetDefaultSortkeyHook.php.

Member Function Documentation

◆ onGetDefaultSortkey()

MediaWiki\Hook\GetDefaultSortkeyHook::onGetDefaultSortkey (   $title,
$sortkey 
)

Use this hook to override the default sortkey for a page.

Since
1.35
Parameters
Title$titleTitle object that we need to get a sortkey for
string&$sortkeySortkey to use
Returns
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: