MediaWiki\Permissions\Hook\TitleReadWhitelistHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onTitleReadWhitelist ( $title, $user, &$whitelisted)
	This hook is called at the end of read permissions checks, just before adding the default error message if nothing allows the user to read the page.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "TitleReadWhitelist" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 15 of file TitleReadWhitelistHook.php.

Member Function Documentation

onTitleReadWhitelist()

MediaWiki\Permissions\Hook\TitleReadWhitelistHook::onTitleReadWhitelist	(		$title,
			$user,
		&	$whitelisted )

This hook is called at the end of read permissions checks, just before adding the default error message if nothing allows the user to read the page.

Since

1.35

Parameters

Title	$title	Title being checked against
User	$user	Current user
bool	&$whitelisted	Whether this title is whitelisted

Returns

bool|void True or no return value to continue, or false to not whitelist the title

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/Permissions/Hook/TitleReadWhitelistHook.php