1fc8d79ac6
For example, documenting the method getUser() with "get the User object" does not add any information that's not already there. But I have to read the text first to understand that it doesn't document anything that's not already obvious from the code. Some of this is from a time when we had a PHPCS sniff that was complaining when a line like `@param User $user` doesn't end with some descriptive text. Some users started adding text like `@param User $user The User` back then. Let's please remove this. Change-Id: I0ea8d051bc732466c73940de9259f87ffb86ce7a
31 lines
983 B
PHP
31 lines
983 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Hook;
|
|
|
|
use IContextSource;
|
|
|
|
/**
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
* Use the hook name "SpecialStatsAddExtra" to register handlers implementing this interface.
|
|
*
|
|
* @stable to implement
|
|
* @ingroup Hooks
|
|
*/
|
|
interface SpecialStatsAddExtraHook {
|
|
/**
|
|
* Use this hook to add extra statistics at the end of Special:Statistics.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param array &$extraStats Array to save the new stats
|
|
* $extraStats['<name of statistic>'] => <value>;
|
|
* <value> can be an array with the keys "name" and "number":
|
|
* "name" is the HTML to be displayed in the name column
|
|
* "number" is the number to be displayed.
|
|
* or, <value> can be the number to be displayed and <name> is the
|
|
* message key to use in the name column,
|
|
* @param IContextSource $context
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onSpecialStatsAddExtra( &$extraStats, $context );
|
|
}
|