c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
27 lines
1 KiB
PHP
27 lines
1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
/**
|
|
* @deprecated since 1.24 Use ApiQueryTokensRegisterTypes instead.
|
|
* @ingroup Hooks
|
|
*/
|
|
interface APIQueryRevisionsTokensHook {
|
|
/**
|
|
* Use this hook to add custom tokens to prop=revisions. Every token has an
|
|
* action, which will be used in the rvtoken parameter and in the output
|
|
* (actiontoken="..."), and a callback function which should return the token, or
|
|
* false if the user isn't allowed to obtain it. The prototype of the callback
|
|
* function is func($pageid, $title, $rev), where $pageid is the page ID of the
|
|
* page associated to the revision the token is requested for, $title the
|
|
* associated Title object and $rev the associated Revision object. In the hook,
|
|
* add your callback to the $tokenFunctions array and return true (returning
|
|
* false makes no sense).
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param array &$tokenFunctions [ action => callback ]
|
|
* @return bool|void True or no return value
|
|
*/
|
|
public function onAPIQueryRevisionsTokens( &$tokenFunctions );
|
|
}
|