MediaWiki\Hook\GetMetadataVersionHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\GetMetadataVersionHook:

Public Member Functions
	onGetMetadataVersion (&$version)
	Use this hook to modify the image metadata version currently in use.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 12 of file GetMetadataVersionHook.php.

Member Function Documentation

onGetMetadataVersion()

MediaWiki\Hook\GetMetadataVersionHook::onGetMetadataVersion

(

&

$version

)

Use this hook to modify the image metadata version currently in use.

This is used when requesting image metadata from a ForeignApiRepo. Media handlers that need to have versioned metadata should add an element to the end of the version array of the form 'handler_name=version'. Most media handlers won't need to do this unless they broke backwards compatibility with a previous version of the media handler metadata output.

Since

1.35

Parameters

string[]

&$version

Array of version strings

Returns

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

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/media/Hook/GetMetadataVersionHook.php