MediaWiki API ヘルプ

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

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

list=prefixsearch (ps)

(main | query | prefixsearch)
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページ名の先頭一致検索を行います。

名前が似ていますが、このモジュールはSpecial:PrefixIndexと等価であることを意図しません。そのような目的ではaction=query&list=allpagesapprefix パラメーターと共に使用してください。このモジュールの目的は action=opensearch と似ています: 利用者から入力を受け取り、最も適合するページ名を提供するというものです。検索エンジンのバックエンドによっては、誤入力の訂正や、転送の回避、その他のヒューリスティクスが適用されることがあります。

パラメーター:
Other general parameters are available.
pssearch

検索文字列。

この変数は必須です。
psnamespace

検索する名前空間。pssearchが有効な名前空間接頭辞で始まる場合は無視されます。

値 (| または別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
すべての値を指定するには、*を用いてください。
既定: 0
pslimit

返す結果の最大数。

型: 整数または max
値は1以上500以下です。
既定: 10
psoffset

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

型: 整数
既定: 0