MediaWiki\Search\Hook\SpecialSearchPowerBoxHook Interface Reference

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

Inheritance diagram for MediaWiki\Search\Hook\SpecialSearchPowerBoxHook:

Public Member Functions
	onSpecialSearchPowerBox (&$showSections, $term, &$opts)
	Use this hook to modify advanced search profile forms.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 12 of file SpecialSearchPowerBoxHook.php.

Member Function Documentation

onSpecialSearchPowerBox()

MediaWiki\Search\Hook\SpecialSearchPowerBoxHook::onSpecialSearchPowerBox	(	&	$showSections,
			$term,
		&	$opts
	)

Use this hook to modify advanced search profile forms.

This hook is equivalent to SpecialSearchProfileForm for the advanced form, also know as power search box.

Since

1.35

Parameters

string[]	&$showSections	Array to add values with more options to
string	$term	Search term (not a title object)
string[]	&$opts	Array of hidden options (containing 'redirs' and 'profile')

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/search/Hook/SpecialSearchPowerBoxHook.php