Довідка API MediaWiki

Це автоматично генерована сторінка документації API MediaWiki.

Документація та приклади: 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=allpages із параметром apprefix. Мета цього модуля така ж, як і action=opensearch: взяти текст, введений користувачем, і вивести найбільш відповідні назви. Залежно від програмної підоснови пошукової системи, сюди можуть також входити виправлення орфографії, уникнення перенаправлень чи інша евристика.

Параметри:
pssearch

Рядок пошуку.

Цей параметр є обов'язковим.
psnamespace

Простори назв, у яких шукати. Ігнорується, якщо pssearch починається з коректного префіксу простору назв.

Значення (розділені через | або альтернативу): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303
Щоб зазначити всі значення, використовуйте *.
Стандартно: 0
pslimit

Максимальна кількість результатів для виведення.

Тип: ціле число або max
Значення має перебувати між 1 та 500.
Стандартно: 10
psoffset

Коли доступно більше результатів, використовуйте це, щоб продовжити.

Тип: ціле число
Стандартно: 0
Приклад:
Шукати назви сторінок, які починаються з meaning.
api.php?action=query&list=prefixsearch&pssearch=meaning [відкрити в пісочниці]