MediaWiki  master
MediaWiki\Api\Hook\ApiMaxLagInfoHook Interface Reference

Stable for implementation. More...

Inheritance diagram for MediaWiki\Api\Hook\ApiMaxLagInfoHook:

Public Member Functions

 onApiMaxLagInfo (&$lagInfo)
 This hook is called when lag information is being requested via API. More...
 

Detailed Description

Stable for implementation.

Definition at line 9 of file ApiMaxLagInfoHook.php.

Member Function Documentation

◆ onApiMaxLagInfo()

MediaWiki\Api\Hook\ApiMaxLagInfoHook::onApiMaxLagInfo ( $lagInfo)

This hook is called when lag information is being requested via API.

Use this hook to override lag information. Generally a hook function should only replace $lagInfo if the new $lagInfo['lag'] is greater than the current $lagInfo['lag'].

Since
1.35
Parameters
array&$lagInfoMaximum lag information array. Fields in the array are:
  • lag: number of seconds of lag
  • host: host name on which the lag exists
  • type: an indication of the type of lag. For example: "db" for database replication lag or "jobqueue" for job queue size converted to pseudo-seconds

You can also add more fields that are returned to the user in the API response.

Returns
void This hook must not abort, it must return no value

Implemented in MediaWiki\Api\ApiHookRunner.


The documentation for this interface was generated from the following file: