Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
MediaWiki\Extension\Translate\MessageGroupProcessing\ProcessAPIMessageGroupsPropertiesHook Interface Reference

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

Inheritance diagram for MediaWiki\Extension\Translate\MessageGroupProcessing\ProcessAPIMessageGroupsPropertiesHook:
MediaWiki\Extension\Translate\HookRunner

Public Member Functions

 onTranslateProcessAPIMessageGroupsProperties (array &$a, array $props, array $params, MessageGroup $g)
 Allows extra property requests to be acted upon, and the new properties returned.
 

Detailed Description

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

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

@stable to implement

Definition at line 15 of file ProcessAPIMessageGroupsPropertiesHook.php.

Member Function Documentation

◆ onTranslateProcessAPIMessageGroupsProperties()

MediaWiki\Extension\Translate\MessageGroupProcessing\ProcessAPIMessageGroupsPropertiesHook::onTranslateProcessAPIMessageGroupsProperties ( array & $a,
array $props,
array $params,
MessageGroup $g )

Allows extra property requests to be acted upon, and the new properties returned.

Parameters
array&$aAssociative array of the properties of $group that will be returned
array$propsAssociative array ($name => true) of properties the user has specifically requested
array$paramsParameter input by the user (unprefixed name => value)
MessageGroup$gThe group in question
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Extension\Translate\HookRunner.


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