Specify hard deprecation Bug: T285805 Change-Id: I2aba03865bd0719fe0b34d49b79f9fb0309158e5
30 lines
976 B
PHP
30 lines
976 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Permissions\Hook;
|
|
|
|
use Title;
|
|
use User;
|
|
|
|
/**
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
* Use the hook name "userCan" to register handlers implementing this interface.
|
|
*
|
|
* @deprecated since 1.37 use getUserPermissionsErrors or getUserPermissionsErrorsExpensive instead.
|
|
* @ingroup Hooks
|
|
*/
|
|
interface UserCanHook {
|
|
/**
|
|
* Use this hook to interrupt or advise the "user can do X to Y article" check.
|
|
* If you want to display an error message, try getUserPermissionsErrors.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param Title $title Title being checked against
|
|
* @param User $user Current user
|
|
* @param string $action Action being checked
|
|
* @param string &$result Pointer to result returned if hook returns false.
|
|
* If null is returned, userCan checks are continued by internal code.
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onUserCan( $title, $user, $action, &$result );
|
|
}
|