MediaWiki  master
MediaWiki\Hook\OpenSearchUrlsHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\OpenSearchUrlsHook:

Public Member Functions

 onOpenSearchUrls (&$urls)
 This hook is called when constructing the OpenSearch description XML. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 12 of file OpenSearchUrlsHook.php.

Member Function Documentation

◆ onOpenSearchUrls()

MediaWiki\Hook\OpenSearchUrlsHook::onOpenSearchUrls ( $urls)

This hook is called when constructing the OpenSearch description XML.

Hooks can alter or append to the array of URLs for search & suggestion formats.

Since
1.35
Parameters
array[]&$urlsArray of associative arrays with URL element attributes
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: