Manual:Hooks/getUserPermissionsErrorsExpensive

From MediaWiki.org
Jump to navigation Jump to search
getUserPermissionsErrorsExpensive
Available from version 1.12.0
Same as getUserPermissionsErrors as but called only if expensive checks are enabled
Define function:
public static function ongetUserPermissionsErrorsExpensive( $title, $user, $action, &$result ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"getUserPermissionsErrorsExpensive": "MyExtensionHooks::ongetUserPermissionsErrorsExpensive"
	}
}

For MediaWiki ≤1.25:

$wgHooks['getUserPermissionsErrorsExpensive'][] = 'MyExtensionHooks::ongetUserPermissionsErrorsExpensive';
Called from: File(s): Title.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:getUserPermissionsErrorsExpensive extensions.

Details[edit]

  • $title: Title object being checked against
  • $user : Current user object
  • $action: Action being checked
  • &$result: User permissions error to add, in a format understood by Title::resultToError() like array( 'error-message-name', $parameter ). If none, return true. Otherwise, the error message is passed all the way to Title::userCan() and then used in whatever way the calling code wants.

Differences from getUserPermissionsErrors[edit]

Both hooks are typically run when checking for proper permissions in Title.phpManual:Title.php. When it is desireable to skip potentially expensive cascading permission checks, only getUserPermissionsErrors is run. This behavior is suitable for nonessential UI controls in common cases, but not for functional access control. This behavior may provide false positives, but should never provide a false negative.