MediaWiki master
MediaWiki\Search\Hook\SearchResultProvideThumbnailHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onSearchResultProvideThumbnail (array $pageIdentities, &$thumbnails, ?int $size=null)
 This hook is called when generating search results in order to fill the 'thumbnail' field in an extension.
 

Detailed Description

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

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

Called in order to allow extensions to fill the 'thumbnail' field in search results. Warning: this hook is under development and still unstable.

Stability: unstable

Definition at line 15 of file SearchResultProvideThumbnailHook.php.

Member Function Documentation

◆ onSearchResultProvideThumbnail()

MediaWiki\Search\Hook\SearchResultProvideThumbnailHook::onSearchResultProvideThumbnail ( array $pageIdentities,
& $thumbnails,
?int $size = null )

This hook is called when generating search results in order to fill the 'thumbnail' field in an extension.

Since
1.35
Parameters
array$pageIdentitiesArray (string=>PageIdentity) where key is pageId
array&$thumbnailsOutput array (string=>SearchResultThumbnail|null) where key is pageId and value is either a valid SearchResultThumbnail for given page or null
int | null$sizesize of thumbnail height and width in points

Implemented in MediaWiki\HookContainer\HookRunner.


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