MediaWiki REL1_39
MediaWiki\Search\Hook\SpecialSearchProfileFormHook Interface Reference

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

Inheritance diagram for MediaWiki\Search\Hook\SpecialSearchProfileFormHook:

Public Member Functions

 onSpecialSearchProfileForm ( $search, &$form, $profile, $term, $opts)
 Use this hook to modify search profile forms.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 14 of file SpecialSearchProfileFormHook.php.

Member Function Documentation

◆ onSpecialSearchProfileForm()

MediaWiki\Search\Hook\SpecialSearchProfileFormHook::onSpecialSearchProfileForm ( $search,
& $form,
$profile,
$term,
$opts )

Use this hook to modify search profile forms.

Since
1.35
Parameters
SpecialPage$search
string&$formForm HTML
string$profileCurrent search profile
string$termSearch term
string[]$optsKey => value of hidden options for inclusion in custom forms
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: