MediaWiki  master
MediaWiki\Hook\GetCanonicalURLHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\GetCanonicalURLHook:

Public Member Functions

 onGetCanonicalURL ( $title, &$url, $query)
 Use this hook to modify fully-qualified URLs used for IRC and email notifications. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file GetCanonicalURLHook.php.

Member Function Documentation

◆ onGetCanonicalURL()

MediaWiki\Hook\GetCanonicalURLHook::onGetCanonicalURL (   $title,
$url,
  $query 
)

Use this hook to modify fully-qualified URLs used for IRC and email notifications.

Since
1.35
Parameters
Title$titleTitle object of page
string&$urlString value as output (out parameter, can modify)
string$queryQuery options as string passed to Title::getCanonicalURL()
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: