aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Hook/GetFullURLHook.php
blob: bfaeff3bfa562bb854b0fca994b0af23b1e76d2e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?php

namespace MediaWiki\Hook;

use Title;

/**
 * @stable for implementation
 * @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 );
}