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

26 lines
721 B
PHP

<?php
namespace MediaWiki\Hook;
use Title;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "GetFullURL" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface GetFullURLHook {
/**
* Use this hook to modify fully-qualified URLs used in redirects/export/offsite data.
*
* @since 1.35
*
* @param Title $title Title object of page
* @param string &$url String value as output (out parameter, can modify)
* @param string $query Query options as string passed to Title::getFullURL()
* @return bool|void True or no return value to continue or false to abort
*/
public function onGetFullURL( $title, &$url, $query );
}