aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Hook/GetCanonicalURLHook.php
blob: 12e0c28b45077275b3c8192b96d3c620dc9ca5ce (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 GetCanonicalURLHook {
	/**
	 * Use this hook to modify fully-qualified URLs used for IRC and email notifications.
	 *
	 * @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::getCanonicalURL()
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onGetCanonicalURL( $title, &$url, $query );
}