c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
26 lines
945 B
PHP
26 lines
945 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
/**
|
|
* @deprecated since 1.24 Use ApiQueryTokensRegisterTypes instead.
|
|
* @ingroup Hooks
|
|
*/
|
|
interface APIQueryInfoTokensHook {
|
|
/**
|
|
* Use this hook to add custom tokens to prop=info. Every token has an
|
|
* action, which will be used in the intoken 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), where $pageid is the page ID of the page the
|
|
* token is requested for and $title is the associated Title 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 onAPIQueryInfoTokens( &$tokenFunctions );
|
|
}
|