MediaWiki\Permissions\Hook\PermissionStatusAuditHook Interface Reference

This is a hook handler interface, see docs/Hooks.md Use the hook name "PermissionStatusAudit" to register handlers implementing this interface. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onPermissionStatusAudit (LinkTarget $title, UserIdentity $user, string $action, string $rigor, PermissionStatus $status)
	This hook is called from PermissionManager::getPermissionStatus() to make any permission status (even if it has no errors) available to consumers.

Detailed Description

This is a hook handler interface, see docs/Hooks.md Use the hook name "PermissionStatusAudit" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 15 of file PermissionStatusAuditHook.php.

Member Function Documentation

onPermissionStatusAudit()

MediaWiki\Permissions\Hook\PermissionStatusAuditHook::onPermissionStatusAudit	(	LinkTarget	$title,
		UserIdentity	$user,
		string	$action,
		string	$rigor,
		PermissionStatus	$status )

This hook is called from PermissionManager::getPermissionStatus() to make any permission status (even if it has no errors) available to consumers.

Parameters

LinkTarget	$title	Page in question
UserIdentity	$user	User to check
string	$action	Action being checked
string	$rigor	One of PermissionManager::RIGOR_ constants
PermissionStatus	$status	Permission check status. This is a read-only copy and can't be modified, use the 'GetUserPermissionsErrors' hook to report permission errors.

Returns

void This hook must not abort, it must return no value

Since

1.44

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Permissions/Hook/PermissionStatusAuditHook.php