MediaWiki\Api\Hook\ApiQueryTokensRegisterTypesHook Interface Reference

Stable to implement. More...

Inheritance diagram for MediaWiki\Api\Hook\ApiQueryTokensRegisterTypesHook:

Public Member Functions
	onApiQueryTokensRegisterTypes (&$salts)
	Use this hook to add additional token types to action=query&meta=tokens.

Detailed Description

Stable to implement.

Definition at line 9 of file ApiQueryTokensRegisterTypesHook.php.

Member Function Documentation

onApiQueryTokensRegisterTypes()

MediaWiki\Api\Hook\ApiQueryTokensRegisterTypesHook::onApiQueryTokensRegisterTypes

(

&

$salts

)

Use this hook to add additional token types to action=query&meta=tokens.

Note that most modules will probably be able to use the CSRF token instead of creating their own token types.

Since

1.35

Parameters

array

&$salts

[ type => salt to pass to User::getEditToken(), or array of salt and key to pass to Session::getToken() ]

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner.

---

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

• includes/api/Hook/ApiQueryTokensRegisterTypesHook.php