CirrusSearch
Elasticsearch-powered search for MediaWiki
Loading...
Searching...
No Matches
CirrusSearch\Hooks\CustomPageFields Class Reference

Hooks to allow custom fields to be added to the search index for pages. More...

+ Inheritance diagram for CirrusSearch\Hooks\CustomPageFields:
+ Collaboration diagram for CirrusSearch\Hooks\CustomPageFields:

Public Member Functions

 onSearchIndexFields (&$fields, $engine)
 Add configured fields to mapping.
 

Static Public Member Functions

static buildSearchIndexFields (SearchEngine $engine, Config $config)
 Build configured fields.
 

Public Attributes

const CONFIG_OPTION = 'CirrusSearchCustomPageFields'
 

Detailed Description

Hooks to allow custom fields to be added to the search index for pages.

Member Function Documentation

◆ buildSearchIndexFields()

static CirrusSearch\Hooks\CustomPageFields::buildSearchIndexFields ( SearchEngine $engine,
Config $config )
static

Build configured fields.

Parameters
SearchEngine$engine
Config$configthe wiki configuration
Returns
SearchIndexField[]

◆ onSearchIndexFields()

CirrusSearch\Hooks\CustomPageFields::onSearchIndexFields ( & $fields,
$engine )

Add configured fields to mapping.

Parameters
array&$fieldsarray of field definitions to update
SearchEngine$enginethe search engine requesting field definitions
See also
https://www.mediawiki.org/wiki/Manual:Hooks/SearchIndexFields

The documentation for this class was generated from the following file: