aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Permissions/Hook/UserIsEveryoneAllowedHook.php
blob: 2dad633f9e6ebb58d2cce5e870a406f2e0e04c0c (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\Permissions\Hook;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "UserIsEveryoneAllowed" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface UserIsEveryoneAllowedHook {
	/**
	 * Use this hook to check if all users are allowed some user right; return
	 * false if a UserGetRights hook might remove the named right.
	 *
	 * @since 1.35
	 *
	 * @param string $right User right being checked
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onUserIsEveryoneAllowed( $right );
}