MediaWiki\Api\Hook\ApiOpenSearchSuggestHook Interface Reference

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

Inherited by MediaWiki\Api\ApiHookRunner.

Public Member Functions
	onApiOpenSearchSuggest (&$results)
	This hook is called when constructing the OpenSearch results.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 12 of file ApiOpenSearchSuggestHook.php.

Member Function Documentation

onApiOpenSearchSuggest()

MediaWiki\Api\Hook\ApiOpenSearchSuggestHook::onApiOpenSearchSuggest

(

&

$results

)

This hook is called when constructing the OpenSearch results.

Hooks can alter or append to the array.

Since

1.35

Parameters

array[]

&$results

Array with integer keys to associative arrays. Keys in associative array: title: Title object redirect from: Title or null extract: Description for this result extract trimmed: If truthy, the extract will not be trimmed to $wgOpenSearchDescriptionLength. image: Thumbnail for this result. Value is an array with subkeys source (URL), width, height, alt, and align. url: URL for the given title

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/ApiOpenSearchSuggestHook.php