Extension:SearchParserFunction

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

• Download and move the extracted SearchParserFunction folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:

  cdextensions/
  gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/SearchParserFunction
  

• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'SearchParserFunction' );
  

• Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

{{#search:foo}}

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

• Foo
• Bar
• Baz

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).

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
}}

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

• Foo
• Bar
• Baz

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

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=;}}

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.

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:

<divstyle="border: 1px solid #aaa; border-radius: 10px; margin: 1em 0; padding: 1em; max-width: 600px;">
<spanstyle="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:

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

Use this hook to add or modify search result formats.

• Extension:SemanticMediaWiki - Much more sophisticated and powerful, but also much more complicated and difficult to maintain. #ask queries can do much than #search can't, but #search can also do some things that #ask can't, such as simple full-text search.
• Extension:DynamicPageList - List pages by category and other criteria.
• Appropedia:Template:Search results - Real use case of this extension.

• Stable extensions
• Parser function extensions
• Search extensions
• ParserFirstCallInit extensions
• GPL licensed extensions
• Extensions in Wikimedia version control
• All extensions

• Extensions without an image
• Extensions without a compatibility policy