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.
  • منبع: MediaWiki
  • License: GPL-2.0+

جستجو در ویکی بااستفاده از پروتکل اوپن‌سرچ.

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
To specify all values, use *.
پیش‌فرض: 0
limit

حداکثر تعداد نتایج برای بازگرداندن.

بيش از ۵۰۰ (برای ربات‌ها ۵٬۰۰۰) مجاز نيست
Type: integer or max
پیش‌فرض: 10
suggest

کاری نکنید اگر $wgEnableOpenSearchSuggest 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

فرمت خروجی.

One of the following values: json، jsonfm، xml، xmlfm
پیش‌فرض: json
warningsaserror

If warnings are raised with format=json, return an API error instead of ignoring them.

Type: boolean (details)
Example:
یافتن صفحه‌هایی که با Te آغاز می‌شوند
api.php?action=opensearch&search=Te [open in sandbox]