MediaWiki API ヘルプ

このページは自動生成された MediaWiki API の説明文書ページです。

説明文書と例: https://www.mediawiki.org/wiki/API

action=opensearch

(main | opensearch)
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

OpenSearch プロトコルを使用してWiki内を検索します。

パラメーター:
search

検索文字列。

limit

返す結果の最大数。

No more than 100 (100 for bots) allowed.
Type: integer or max
既定値: 10
namespace

検索する名前空間。

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
既定値: 0
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.

値 (次の値のいずれか1つ): return、resolve
format

出力する形式。

値 (次の値のいずれか1つ): json、jsonfm、xml、xmlfm
既定値: json
warningsaserror

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

Type: boolean (details)
例:
Te から始まるページを検索する。
api.php?action=opensearch&search=Te