MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
action=opensearch
(main | opensearch)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Search the wiki using the OpenSearch protocol.
Parameters:
- search
سطر البحث
- This parameter is required.
- namespace
النطاقات للبحث.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15، 828، 829، 2300، 2301، 2302، 2303
- Default: 0
- limit
الحد الأقصى للنتائج المُرجعة
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- suggest
Do nothing if $wgEnableOpenSearchSuggest is false.
- Type: boolean (details)
- redirects
How to handle redirects:
- return
- Return the redirect itself.
- resolve
- Return the target page. May return fewer than limit results.
For historical reasons, the default is "return" for format=json and "resolve" for other formats.
- One of the following values: return، resolve
- format
The format of the output.
- One of the following values: json، jsonfm، xml، xmlfm
- Default: json
- warningsaserror
If warnings are raised with format=json, return an API error instead of ignoring them.
- Type: boolean (details)
Examples:
- Find pages beginning with Te.
- api.php?action=opensearch&search=Te [open in sandbox]