MediaWiki  master
MediaWiki\Hook\TestCanonicalRedirectHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\TestCanonicalRedirectHook:

Public Member Functions

 onTestCanonicalRedirect ( $request, $title, $output)
 This hook is called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 16 of file TestCanonicalRedirectHook.php.

Member Function Documentation

◆ onTestCanonicalRedirect()

MediaWiki\Hook\TestCanonicalRedirectHook::onTestCanonicalRedirect (   $request,
  $title,
  $output 
)

This hook is called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL.

Use this hook to alter page view behavior radically to abort that redirect or handle it manually.

Since
1.35
Parameters
WebRequest$request
Title$titleTitle of the currently found Title object
OutputPage$output
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: