wiki.techinc.nl/includes/Hook/TestCanonicalRedirectHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

31 lines
871 B
PHP

<?php
namespace MediaWiki\Hook;
use OutputPage;
use Title;
use WebRequest;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "TestCanonicalRedirect" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface TestCanonicalRedirectHook {
/**
* 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
*
* @param WebRequest $request
* @param Title $title Title of the currently found Title object
* @param OutputPage $output
* @return bool|void True or no return value to continue or false to abort
*/
public function onTestCanonicalRedirect( $request, $title, $output );
}