Manual:Hooks/SpecialSearchProfileForm

From MediaWiki.org
Jump to navigation Jump to search
SpecialSearchProfileForm
Available from version 1.18.0 (r86714)
allows modification of search profile forms
Define function:
public static function onSpecialSearchProfileForm( SpecialSearch $search, &$form, &profile, $term, array $opts ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"SpecialSearchProfileForm": "MyExtensionHooks::onSpecialSearchProfileForm"
	}
}

For MediaWiki ≤1.25:

$wgHooks['SpecialSearchProfileForm'][] = 'MyExtensionHooks::onSpecialSearchProfileForm';
Called from:File(s): SpecialSearch.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:SpecialSearchProfileForm extensions.

Details[edit]

  • $search: SpecialSearch object
  • &$form: String: form html
  • $profile: String: current search profile
  • $term: String: search term
  • $opts: Array: key => value of hidden options for inclusion in custom forms

See also[edit]