MediaWiki REL1_30
ApiQueryRevisions.php
Go to the documentation of this file.
1<?php
36
37 private $token = null;
38
39 public function __construct( ApiQuery $query, $moduleName ) {
40 parent::__construct( $query, $moduleName, 'rv' );
41 }
42
44
46 protected function getTokenFunctions() {
47 // tokenname => function
48 // function prototype is func($pageid, $title, $rev)
49 // should return token or false
50
51 // Don't call the hooks twice
52 if ( isset( $this->tokenFunctions ) ) {
54 }
55
56 // If we're in a mode that breaks the same-origin policy, no tokens can
57 // be obtained
58 if ( $this->lacksSameOriginSecurity() ) {
59 return [];
60 }
61
62 $this->tokenFunctions = [
63 'rollback' => [ 'ApiQueryRevisions', 'getRollbackToken' ]
64 ];
65 Hooks::run( 'APIQueryRevisionsTokens', [ &$this->tokenFunctions ] );
66
68 }
69
77 public static function getRollbackToken( $pageid, $title, $rev ) {
78 global $wgUser;
79 if ( !$wgUser->isAllowed( 'rollback' ) ) {
80 return false;
81 }
82
83 return $wgUser->getEditToken( 'rollback' );
84 }
85
86 protected function run( ApiPageSet $resultPageSet = null ) {
87 $params = $this->extractRequestParams( false );
88
89 // If any of those parameters are used, work in 'enumeration' mode.
90 // Enum mode can only be used when exactly one page is provided.
91 // Enumerating revisions on multiple pages make it extremely
92 // difficult to manage continuations and require additional SQL indexes
93 $enumRevMode = ( $params['user'] !== null || $params['excludeuser'] !== null ||
94 $params['limit'] !== null || $params['startid'] !== null ||
95 $params['endid'] !== null || $params['dir'] === 'newer' ||
96 $params['start'] !== null || $params['end'] !== null );
97
98 $pageSet = $this->getPageSet();
99 $pageCount = $pageSet->getGoodTitleCount();
100 $revCount = $pageSet->getRevisionCount();
101
102 // Optimization -- nothing to do
103 if ( $revCount === 0 && $pageCount === 0 ) {
104 // Nothing to do
105 return;
106 }
107 if ( $revCount > 0 && count( $pageSet->getLiveRevisionIDs() ) === 0 ) {
108 // We're in revisions mode but all given revisions are deleted
109 return;
110 }
111
112 if ( $revCount > 0 && $enumRevMode ) {
113 $this->dieWithError(
114 [ 'apierror-revisions-nolist', $this->getModulePrefix() ], 'invalidparammix'
115 );
116 }
117
118 if ( $pageCount > 1 && $enumRevMode ) {
119 $this->dieWithError(
120 [ 'apierror-revisions-singlepage', $this->getModulePrefix() ], 'invalidparammix'
121 );
122 }
123
124 // In non-enum mode, rvlimit can't be directly used. Use the maximum
125 // allowed value.
126 if ( !$enumRevMode ) {
127 $this->setParsedLimit = false;
128 $params['limit'] = 'max';
129 }
130
131 $db = $this->getDB();
132 $this->addTables( [ 'revision', 'page' ] );
133 $this->addJoinConds(
134 [ 'page' => [ 'INNER JOIN', [ 'page_id = rev_page' ] ] ]
135 );
136
137 if ( $resultPageSet === null ) {
138 $this->parseParameters( $params );
139 $this->token = $params['token'];
141 if ( $this->token !== null || $pageCount > 0 ) {
143 }
144 } else {
145 $this->limit = $this->getParameter( 'limit' ) ?: 10;
146 $this->addFields( [ 'rev_id', 'rev_timestamp', 'rev_page' ] );
147 }
148
149 if ( $this->fld_tags ) {
150 $this->addTables( 'tag_summary' );
151 $this->addJoinConds(
152 [ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
153 );
154 $this->addFields( 'ts_tags' );
155 }
156
157 if ( $params['tag'] !== null ) {
158 $this->addTables( 'change_tag' );
159 $this->addJoinConds(
160 [ 'change_tag' => [ 'INNER JOIN', [ 'rev_id=ct_rev_id' ] ] ]
161 );
162 $this->addWhereFld( 'ct_tag', $params['tag'] );
163 }
164
165 if ( $this->fetchContent ) {
166 // For each page we will request, the user must have read rights for that page
167 $user = $this->getUser();
168 $status = Status::newGood();
170 foreach ( $pageSet->getGoodTitles() as $title ) {
171 if ( !$title->userCan( 'read', $user ) ) {
173 [ 'apierror-cannotviewtitle', wfEscapeWikiText( $title->getPrefixedText() ) ],
174 'accessdenied'
175 ) );
176 }
177 }
178 if ( !$status->isGood() ) {
179 $this->dieStatus( $status );
180 }
181
182 $this->addTables( 'text' );
183 $this->addJoinConds(
184 [ 'text' => [ 'INNER JOIN', [ 'rev_text_id=old_id' ] ] ]
185 );
186 $this->addFields( 'old_id' );
188 }
189
190 // add user name, if needed
191 if ( $this->fld_user ) {
192 $this->addTables( 'user' );
193 $this->addJoinConds( [ 'user' => Revision::userJoinCond() ] );
195 }
196
197 if ( $enumRevMode ) {
198 // Indexes targeted:
199 // page_timestamp if we don't have rvuser
200 // page_user_timestamp if we have a logged-in rvuser
201 // page_timestamp or usertext_timestamp if we have an IP rvuser
202
203 // This is mostly to prevent parameter errors (and optimize SQL?)
204 $this->requireMaxOneParameter( $params, 'startid', 'start' );
205 $this->requireMaxOneParameter( $params, 'endid', 'end' );
206 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
207
208 if ( $params['continue'] !== null ) {
209 $cont = explode( '|', $params['continue'] );
210 $this->dieContinueUsageIf( count( $cont ) != 2 );
211 $op = ( $params['dir'] === 'newer' ? '>' : '<' );
212 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
213 $continueId = (int)$cont[1];
214 $this->dieContinueUsageIf( $continueId != $cont[1] );
215 $this->addWhere( "rev_timestamp $op $continueTimestamp OR " .
216 "(rev_timestamp = $continueTimestamp AND " .
217 "rev_id $op= $continueId)"
218 );
219 }
220
221 // Convert startid/endid to timestamps (T163532)
222 $revids = [];
223 if ( $params['startid'] !== null ) {
224 $revids[] = (int)$params['startid'];
225 }
226 if ( $params['endid'] !== null ) {
227 $revids[] = (int)$params['endid'];
228 }
229 if ( $revids ) {
230 $db = $this->getDB();
231 $sql = $db->unionQueries( [
232 $db->selectSQLText(
233 'revision',
234 [ 'id' => 'rev_id', 'ts' => 'rev_timestamp' ],
235 [ 'rev_id' => $revids ],
236 __METHOD__
237 ),
238 $db->selectSQLText(
239 'archive',
240 [ 'id' => 'ar_rev_id', 'ts' => 'ar_timestamp' ],
241 [ 'ar_rev_id' => $revids ],
242 __METHOD__
243 ),
244 ], false );
245 $res = $db->query( $sql, __METHOD__ );
246 foreach ( $res as $row ) {
247 if ( (int)$row->id === (int)$params['startid'] ) {
248 $params['start'] = $row->ts;
249 }
250 if ( (int)$row->id === (int)$params['endid'] ) {
251 $params['end'] = $row->ts;
252 }
253 }
254 if ( $params['startid'] !== null && $params['start'] === null ) {
255 $p = $this->encodeParamName( 'startid' );
256 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
257 }
258 if ( $params['endid'] !== null && $params['end'] === null ) {
259 $p = $this->encodeParamName( 'endid' );
260 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
261 }
262
263 if ( $params['start'] !== null ) {
264 $op = ( $params['dir'] === 'newer' ? '>' : '<' );
265 $ts = $db->addQuotes( $db->timestampOrNull( $params['start'] ) );
266 if ( $params['startid'] !== null ) {
267 $this->addWhere( "rev_timestamp $op $ts OR "
268 . "rev_timestamp = $ts AND rev_id $op= " . intval( $params['startid'] ) );
269 } else {
270 $this->addWhere( "rev_timestamp $op= $ts" );
271 }
272 }
273 if ( $params['end'] !== null ) {
274 $op = ( $params['dir'] === 'newer' ? '<' : '>' ); // Yes, opposite of the above
275 $ts = $db->addQuotes( $db->timestampOrNull( $params['end'] ) );
276 if ( $params['endid'] !== null ) {
277 $this->addWhere( "rev_timestamp $op $ts OR "
278 . "rev_timestamp = $ts AND rev_id $op= " . intval( $params['endid'] ) );
279 } else {
280 $this->addWhere( "rev_timestamp $op= $ts" );
281 }
282 }
283 } else {
284 $this->addTimestampWhereRange( 'rev_timestamp', $params['dir'],
285 $params['start'], $params['end'] );
286 }
287
288 $sort = ( $params['dir'] === 'newer' ? '' : 'DESC' );
289 $this->addOption( 'ORDER BY', [ "rev_timestamp $sort", "rev_id $sort" ] );
290
291 // There is only one ID, use it
292 $ids = array_keys( $pageSet->getGoodTitles() );
293 $this->addWhereFld( 'rev_page', reset( $ids ) );
294
295 if ( $params['user'] !== null ) {
296 $user = User::newFromName( $params['user'] );
297 if ( $user && $user->getId() > 0 ) {
298 $this->addWhereFld( 'rev_user', $user->getId() );
299 } else {
300 $this->addWhereFld( 'rev_user_text', $params['user'] );
301 }
302 } elseif ( $params['excludeuser'] !== null ) {
303 $user = User::newFromName( $params['excludeuser'] );
304 if ( $user && $user->getId() > 0 ) {
305 $this->addWhere( 'rev_user != ' . $user->getId() );
306 } else {
307 $this->addWhere( 'rev_user_text != ' .
308 $db->addQuotes( $params['excludeuser'] ) );
309 }
310 }
311 if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
312 // Paranoia: avoid brute force searches (T19342)
313 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
314 $bitmask = Revision::DELETED_USER;
315 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
317 } else {
318 $bitmask = 0;
319 }
320 if ( $bitmask ) {
321 $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
322 }
323 }
324 } elseif ( $revCount > 0 ) {
325 // Always targets the PRIMARY index
326
327 $revs = $pageSet->getLiveRevisionIDs();
328
329 // Get all revision IDs
330 $this->addWhereFld( 'rev_id', array_keys( $revs ) );
331
332 if ( $params['continue'] !== null ) {
333 $this->addWhere( 'rev_id >= ' . intval( $params['continue'] ) );
334 }
335 $this->addOption( 'ORDER BY', 'rev_id' );
336 } elseif ( $pageCount > 0 ) {
337 // Always targets the rev_page_id index
338
339 $titles = $pageSet->getGoodTitles();
340
341 // When working in multi-page non-enumeration mode,
342 // limit to the latest revision only
343 $this->addWhere( 'page_latest=rev_id' );
344
345 // Get all page IDs
346 $this->addWhereFld( 'page_id', array_keys( $titles ) );
347 // Every time someone relies on equality propagation, god kills a kitten :)
348 $this->addWhereFld( 'rev_page', array_keys( $titles ) );
349
350 if ( $params['continue'] !== null ) {
351 $cont = explode( '|', $params['continue'] );
352 $this->dieContinueUsageIf( count( $cont ) != 2 );
353 $pageid = intval( $cont[0] );
354 $revid = intval( $cont[1] );
355 $this->addWhere(
356 "rev_page > $pageid OR " .
357 "(rev_page = $pageid AND " .
358 "rev_id >= $revid)"
359 );
360 }
361 $this->addOption( 'ORDER BY', [
362 'rev_page',
363 'rev_id'
364 ] );
365 } else {
366 ApiBase::dieDebug( __METHOD__, 'param validation?' );
367 }
368
369 $this->addOption( 'LIMIT', $this->limit + 1 );
370
371 $count = 0;
372 $generated = [];
373 $hookData = [];
374 $res = $this->select( __METHOD__, [], $hookData );
375
376 foreach ( $res as $row ) {
377 if ( ++$count > $this->limit ) {
378 // We've reached the one extra which shows that there are
379 // additional pages to be had. Stop here...
380 if ( $enumRevMode ) {
381 $this->setContinueEnumParameter( 'continue',
382 $row->rev_timestamp . '|' . intval( $row->rev_id ) );
383 } elseif ( $revCount > 0 ) {
384 $this->setContinueEnumParameter( 'continue', intval( $row->rev_id ) );
385 } else {
386 $this->setContinueEnumParameter( 'continue', intval( $row->rev_page ) .
387 '|' . intval( $row->rev_id ) );
388 }
389 break;
390 }
391
392 if ( $resultPageSet !== null ) {
393 $generated[] = $row->rev_id;
394 } else {
395 $revision = new Revision( $row );
396 $rev = $this->extractRevisionInfo( $revision, $row );
397
398 if ( $this->token !== null ) {
399 $title = $revision->getTitle();
401 foreach ( $this->token as $t ) {
402 $val = call_user_func( $tokenFunctions[$t], $title->getArticleID(), $title, $revision );
403 if ( $val === false ) {
404 $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
405 } else {
406 $rev[$t . 'token'] = $val;
407 }
408 }
409 }
410
411 $fit = $this->processRow( $row, $rev, $hookData ) &&
412 $this->addPageSubItem( $row->rev_page, $rev, 'rev' );
413 if ( !$fit ) {
414 if ( $enumRevMode ) {
415 $this->setContinueEnumParameter( 'continue',
416 $row->rev_timestamp . '|' . intval( $row->rev_id ) );
417 } elseif ( $revCount > 0 ) {
418 $this->setContinueEnumParameter( 'continue', intval( $row->rev_id ) );
419 } else {
420 $this->setContinueEnumParameter( 'continue', intval( $row->rev_page ) .
421 '|' . intval( $row->rev_id ) );
422 }
423 break;
424 }
425 }
426 }
427
428 if ( $resultPageSet !== null ) {
429 $resultPageSet->populateFromRevisionIDs( $generated );
430 }
431 }
432
433 public function getCacheMode( $params ) {
434 if ( isset( $params['token'] ) ) {
435 return 'private';
436 }
437 return parent::getCacheMode( $params );
438 }
439
440 public function getAllowedParams() {
441 $ret = parent::getAllowedParams() + [
442 'startid' => [
443 ApiBase::PARAM_TYPE => 'integer',
444 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
445 ],
446 'endid' => [
447 ApiBase::PARAM_TYPE => 'integer',
448 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
449 ],
450 'start' => [
451 ApiBase::PARAM_TYPE => 'timestamp',
452 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
453 ],
454 'end' => [
455 ApiBase::PARAM_TYPE => 'timestamp',
456 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
457 ],
458 'dir' => [
459 ApiBase::PARAM_DFLT => 'older',
461 'newer',
462 'older'
463 ],
464 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
465 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
466 ],
467 'user' => [
468 ApiBase::PARAM_TYPE => 'user',
469 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
470 ],
471 'excludeuser' => [
472 ApiBase::PARAM_TYPE => 'user',
473 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
474 ],
475 'tag' => null,
476 'token' => [
478 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
480 ],
481 'continue' => [
482 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
483 ],
484 ];
485
486 $ret['limit'][ApiBase::PARAM_HELP_MSG_INFO] = [ [ 'singlepageonly' ] ];
487
488 return $ret;
489 }
490
491 protected function getExamplesMessages() {
492 return [
493 'action=query&prop=revisions&titles=API|Main%20Page&' .
494 'rvprop=timestamp|user|comment|content'
495 => 'apihelp-query+revisions-example-content',
496 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
497 'rvprop=timestamp|user|comment'
498 => 'apihelp-query+revisions-example-last5',
499 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
500 'rvprop=timestamp|user|comment&rvdir=newer'
501 => 'apihelp-query+revisions-example-first5',
502 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
503 'rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z'
504 => 'apihelp-query+revisions-example-first5-after',
505 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
506 'rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1'
507 => 'apihelp-query+revisions-example-first5-not-localhost',
508 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
509 'rvprop=timestamp|user|comment&rvuser=MediaWiki%20default'
510 => 'apihelp-query+revisions-example-first5-user',
511 ];
512 }
513
514 public function getHelpUrls() {
515 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Revisions';
516 }
517}
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
$wgUser
Definition Setup.php:817
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition ApiBase.php:520
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition ApiBase.php:109
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition ApiBase.php:764
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1855
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:2026
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition ApiBase.php:2038
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:91
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition ApiBase.php:145
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:52
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:740
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition ApiBase.php:814
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:128
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1779
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition ApiBase.php:1920
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:55
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition ApiBase.php:560
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
This class contains a list of pages that the client has requested.
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
addFields( $value)
Add a set of fields to select to the internal array.
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
getDB()
Get the Query database connection (read-only)
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
addWhere( $value)
Add a set of WHERE clauses to the internal array.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
getPageSet()
Get the PageSet object to work on.
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
A base class for functions common to producing a list of revisions.
parseParameters( $params)
Parse the parameters into the various instance fields.
extractRevisionInfo(Revision $revision, $row)
Extract information from the Revision.
A query action to enumerate revisions of a given page, or show top revisions of multiple pages.
__construct(ApiQuery $query, $moduleName)
getCacheMode( $params)
Get the cache mode for the data generated by this module.
getHelpUrls()
Return links to more detailed help pages about the module.
run(ApiPageSet $resultPageSet=null)
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
static getRollbackToken( $pageid, $title, $rev)
getExamplesMessages()
Returns usage examples for this module.
This is the main query class.
Definition ApiQuery.php:40
getUser()
Get the User object.
static userJoinCond()
Return the value of a select() JOIN conds array for the user table.
Definition Revision.php:431
static selectTextFields()
Return the list of text fields that should be selected to read the revision text.
Definition Revision.php:518
static selectPageFields()
Return the list of page fields that should be selected from page table.
Definition Revision.php:529
static selectFields()
Return the list of revision fields that should be selected to create a new revision.
Definition Revision.php:452
static selectUserFields()
Return the list of user fields that should be selected from user table.
Definition Revision.php:544
const DELETED_USER
Definition Revision.php:92
const DELETED_RESTRICTED
Definition Revision.php:93
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like select() and insert() are usually more convenient. They take care of things like table prefixes and escaping for you. If you really need to make your own SQL
$res
Definition database.txt:21
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition hooks.txt:1976
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:1975
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1049
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1610
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition hooks.txt:1760
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition linkcache.txt:17
$sort
$params