MediaWiki\Api\Hook\ApiBlockSucceededHook Interface Reference

Inherited by MediaWiki\Api\ApiHookRunner.

Public Member Functions
	onApiBlockSucceeded ( $module, $performer, $mainTarget, $params, &$additionalBlocksStatuses)
	This hook is called from ApiBlock.

Detailed Description

Stability: unstable

Definition at line 13 of file ApiBlockSucceededHook.php.

Member Function Documentation

onApiBlockSucceeded()

MediaWiki\Api\Hook\ApiBlockSucceededHook::onApiBlockSucceeded	(		$module,
			$performer,
			$mainTarget,
			$params,
		&	$additionalBlocksStatuses )

This hook is called from ApiBlock.

It allows callers to respond to a successful block with support for passing back the results of subsequent blocks in the response.

Since

1.46

Parameters

ApiBlock	$module
Authority	$performer
UserIdentity	$mainTarget
array	$params
array	&$additionalBlocksStatuses

Returns

void

Implemented in MediaWiki\Api\ApiHookRunner.

---

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

• includes/Api/Hook/ApiBlockSucceededHook.php