Wikimore

**MediaWiki extensions manual**
SearchParserFunction; Release status: stableCategory:Stable extensions
Implementation	Parser functionCategory:Parser function extensions, SearchCategory:Search extensions
Description	Adds a parser function to search, format and display search results in wiki pages.
Author(s)	Sophivorustalk
Latest version	2.1
MediaWiki	>= 1.40.0
Database changes	No
	Hooks used ParserFirstCallInitCategory:ParserFirstCallInit extensions;
Licence	GNU General Public License 3.0 or later
Download	Download extension ; Git [?]: Browse repository (GitHub); Gerrit code review; Git commit log; Download source tarball; Category:Extensions in Wikimedia version control
Example	Appropedia
	Translate the SearchParserFunction extension if it is available at translatewiki.net

Category:Extensions without an image Category:Extensions without a compatibility policy Category:GPL licensed extensionsCategory:All extensions

The SearchParserFunction extension adds a parser function to search, format and display search results in wiki pages.

Installation

Download and move the extracted SearchParserFunction folder to your extensions/ directory.
Developers and code contributors should install the extension from Git instead, using:
```
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SearchParserFunction
```
Add the following code at the bottom of your LocalSettings.php file:
```
wfLoadExtension( 'SearchParserFunction' );
```
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

Basic usage

{{#search:foo}}

This will search for pages that contain foo and return the results as a list of links, like so:

You can use all available search operators. For example, if you're using CirrusSearch :

{{#search:foo incategory:"Bar" linksto:"Baz"}}

See Help:CirrusSearch for all available search operators (or API:Search if you're not using CirrusSearch).

The current page will be excluded from the search results.

Parameters

Name	Default	Description
`namespace`	0	Namespace to search. Separate multiple values with commas. (See namespace constants .)
`limit`	10	Max number of results, should be either an integer or 'max'.
`offset`	0	Number of results to skip, useful to access results beyond the 'max' limit.
`profile`		Ranking algorithm to use, defaults to let the engine decide.
`what`	`'text'`	Type of search to perform, either 'text', 'title' or 'nearmatch'. 'title' doesn't work when CirrusSearch is enabled (use intitle instead).
`interwiki`		Include interwiki results in the search, if available.
`rewrites`		Enable internal query rewriting, for example to correct spelling mistakes.
`sort`	`'relevance'`	Sorting criteria.
`format`	`'list'`	Format of the search results. (See below for more.)

For example, to get the name of the latest file that has foo in the title:

{{#search: foo
| namespace = 6
| limit = 1
| what = title
| sort = create_timestamp_asc
| format = plain
}}

Formats

List

Returns an unordered list (‎<ul>) of search results, linked to their pages. For example:

Count

Returns the total number of search results as a plain number.

Plain

Returns a comma-separated list of plain titles. For example:

Foo, Bar, Baz

This format is designed for further processing. For example, using the #arraymap function of Extension:PageForms :

{{#arraymap: {{#search:foo}} | , | @ | [[@]] | <br> }}

This would output the search results one below the other and linked to their pages, like so:

Foo
Bar
Baz

If some of the titles contain commas, you can change the separator like so:

{{#search:foo|separator=;}}

JSON

Returns a JSON object for further processing, for example in a Lua module .

Note that this format returns the entire output from the Search API, not just the search results.

Template

Returns the search results wrapped in a template. The search result title is passed to the template as an unnamed parameter {{{1}}} and may be used or ignored.

For example, if a template named "Search result" contained the following:

<div style="border: 1px solid #aaa; border-radius: 10px; margin: 1em 0; padding: 1em; max-width: 600px;">
<span style="font-size:120%">[[{{{1}}}]]</span>
<p>{{fullurl:{{{1}}}}}</p>
</div>

then a query such as:

{{#search: foo
| format = template
| template = Search result
}}

would output something like this:

Foo

https://www.mediawiki.org/wiki/Foo

Bar

https://www.mediawiki.org/wiki/Bar

Baz

https://www.mediawiki.org/wiki/Baz

Hooks

SearchParserFunctionQuery

Use this hook to customize the query to the Search API.

SearchParserFunctionOutput

Use this hook to add or modify search result formats.