1<?php
2
3namespace MediaWiki\Permissions\Hook;
4
5use Title;
6use User;
7
8/**
9 * @stable to implement
10 * @ingroup Hooks
11 */
12interface TitleReadWhitelistHook {
13	/**
14	 * This hook is called at the end of read permissions checks, just before
15	 * adding the default error message if nothing allows the user to read the page.
16	 *
17	 * @since 1.35
18	 *
19	 * @param Title $title Title being checked against
20	 * @param User $user Current user
21	 * @param bool &$whitelisted Whether this title is whitelisted
22	 * @return bool|void True or no return value to continue, or false to *not* whitelist
23	 *   the title
24	 */
25	public function onTitleReadWhitelist( $title, $user, &$whitelisted );
26}
27