aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Hook/MovePageCheckPermissionsHook.php
blob: 7df5629b9df457360d58e0a7bb978e0c29e4c6a3 (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
24
25
26
27
28
29
30
31
32
<?php

namespace MediaWiki\Hook;

use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use MediaWiki\User\User;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "MovePageCheckPermissions" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface MovePageCheckPermissionsHook {
	/**
	 * Use this hook to specify whether the user is allowed to move the page.
	 *
	 * @since 1.35
	 *
	 * @param Title $oldTitle Current (old) location
	 * @param Title $newTitle New location
	 * @param User $user User making the move
	 * @param string|null $reason Reason provided by the user
	 * @param Status $status Status object to pass error messages to
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onMovePageCheckPermissions( $oldTitle, $newTitle, $user,
		$reason, $status
	);
}