MediaWiki\Api\Hook\ApiMaxLagInfoHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\Api\ApiHookRunner.

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

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "ApiMaxLagInfo" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 12 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

&$lagInfo

Maximum 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:

• includes/api/Hook/ApiMaxLagInfoHook.php