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
32 lines
1 KiB
PHP
32 lines
1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Hook;
|
|
|
|
use SpecialNewpages;
|
|
use stdClass;
|
|
|
|
/**
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
* Use the hook name "NewPagesLineEnding" to register handlers implementing this interface.
|
|
*
|
|
* @stable to implement
|
|
* @ingroup Hooks
|
|
*/
|
|
interface NewPagesLineEndingHook {
|
|
/**
|
|
* This hook is called before a NewPages line is finished.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param SpecialNewPages $page
|
|
* @param string &$ret the HTML line
|
|
* @param stdClass $row The database row for this page (the recentchanges record and a few extras
|
|
* - see NewPagesPager::getQueryInfo)
|
|
* @param string[] &$classes The classes to add to the surrounding <li>
|
|
* @param string[] &$attribs Associative array of other HTML attributes for the <li> element.
|
|
* Currently only data attributes reserved to MediaWiki are allowed
|
|
* (see Sanitizer::isReservedDataAttribute).
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onNewPagesLineEnding( $page, &$ret, $row, &$classes, &$attribs );
|
|
}
|