wiki.techinc.nl/includes/Permissions/Hook/TitleQuickPermissionsHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

33 lines
975 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 "TitleQuickPermissions" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface TitleQuickPermissionsHook {
/**
* This hook is called from Title::checkQuickPermissions to add to
* or override the quick permissions check.
*
* @since 1.35
*
* @param Title $title Title being accessed
* @param User $user User performing the action
* @param string $action Action being performed
* @param array &$errors Array of errors
* @param bool $doExpensiveQueries Whether to do expensive database queries
* @param bool $short Whether to return immediately on first error
* @return bool|void True or no return value to continue or false to abort
*/
public function onTitleQuickPermissions( $title, $user, $action, &$errors,
$doExpensiveQueries, $short
);
}