[WordPress] 外掛分享： REST API for Relevanssi

前言介紹

  • 這款 WordPress 外掛「REST API for Relevanssi」是 2018-09-11 上架。
  • 目前有 300 個安裝啟用數。
  • 上一次更新是 2023-05-14，距離現在已有 720 天。超過一年沒更新，安裝要確認版本是否可用。以及後續維護問題！
  • 外掛最低要求 WordPress 4.6 以上版本才可以安裝。
  • 外掛要求網站主機運作至少需要 PHP 版本 5.6 以上。
  • 有 3 人給過評分。
  • 還沒有人在論壇上發問，可能目前使用數不多，還沒有什麼大問題。

外掛協作開發者

dzysyak |

外掛標籤

api | search | rest-api | Relevanssi |

內容簡介

此外掛提供簡單的 REST API 給受歡迎的 WordPress 搜尋引擎 - Relevanssi 使用。由於此外掛提供 Relevanssi 的 API，因此必須安裝它。主要功能包括：搜尋特定類型的文章；分頁及選擇性顯示結果；設置 X-WP-Total 標頭以顯示記錄的總數，以及類似於預設搜尋 API 的方式；設置 X-WP-TotalPages 標頭以顯示頁數的總數；支援多語言網站，支援 WPML 和 Polylang，但未經測試，如有問題請告知；現在支援分類法篩選，一些功能可能會失蹤，如有發現請報告；添加排序選項，也可以按 meta_key/meta_value/meta_value_num 排序等。

使用範例包括：基本搜尋、設定文章類型、篩選法及排除搜尋結果，以及多語言網站的搜尋等。此外掛提供的示範網站為 http://demo.erlycoder.com/demo1/，可以嘗試不同的搜尋請求，例如按修改時間排列文章等。

原文外掛簡介

This plugin provides simple REST API for the popular search WordPress search engine – Relevanssi.
As far as this plugin provides API for the Relevanssi plugin, it should be installed.
Key features

Search through posts of a certain type. By default all types.
Results in pagination and optional.
Sets X-WP-Total header with a total number of records, the same way as the default search API does.
Sets X-WP-TotalPages header with a total number of pages, the same way as the default search API does.
Multilingual websites support. Both WPML and Polylang are supported, but not tested well, so let me know if you will find any problems.
Taxonomy filters are supported now. Some features may be missed, so feel free to report them.
Ordering option added. It is also possible to order by meta_key/meta_value/meta_value_num.

Brief usage examples

https://[your domain]/wp-json/relevanssi/v1/search?keyword=query
https://[your domain]/wp-json/relevanssi/v1/search?keyword=query&per_page=5
https://[your domain]/wp-json/relevanssi/v1/search?keyword=query&per_page=5&page=2

Define post type:

https://[your domain]/wp-json/relevanssi/v1/search?keyword=query&per_page=5&page=2&type=post

Filter by taxonomy/taxonomies:

https://[your domain]/wp-json/relevanssi/v1/search?keyword=test&tax_query[0][taxonomy]=category&tax_query[0][field]=id&tax_query[0][terms]=3
https://[your domain]/wp-json/relevanssi/v1/search?keyword=test&tax_query[relation]=AND&tax_query[0][taxonomy]=category&tax_query[0][field]=id&tax_query[0][terms]=3&tax_query[1][taxonomy]=category&tax_query[1][field]=id&tax_query[1][terms]=2

Exclude category via taxonomies:

https://[your domain]/wp-json/relevanssi/v1/search?keyword=test&tax_query[0][taxonomy]=category&tax_query[0][field]=id&tax_query[0][terms]=3&tax_query[0][operator]=NOT IN

For multilingual websites (WPML & Polylang):

https://[your domain]/wp-json/relevanssi/v1/search?keyword=query&lng=en

Results in order:

https://[your domain]/wp-json/relevanssi/v1/search?keyword=test&type=post&orderby=modified&order=DESC

https://[your domain]/wp-json/relevanssi/v1/search?keyword=test&type=post&orderby=modified&order=ASC
https://[your domain]/wp-json/relevanssi/v1/search?keyword=test&type=post&meta_key=some_key&orderby=meta_value|meta_value_num&order=ASC

Demo website
You can try the plugin on our demo website http://demo.erlycoder.com/demo1/. For example, you can try the following request:
Basic:
http://demo.erlycoder.com/demo1/wp-json/relevanssi/v1/search?keyword=test
Order posts by modification time:
http://demo.erlycoder.com/demo1/wp-json/relevanssi/v1/search?keyword=test&type=post&orderby=modified&order=DESC
http://demo.erlycoder.com/demo1/wp-json/relevanssi/v1/search?keyword=test&type=post&orderby=modified&order=ASC
Filter posts by taxonomy (one single category):
http://demo.erlycoder.com/demo1/wp-json/relevanssi/v1/search?keyword=test&tax_query[0][taxonomy]=category&tax_query[0][field]=id&tax_query[0][terms]=3
Filter posts by taxonomy (exclude category):
[http://demo.erlycoder.com/demo1/wp-json/relevanssi/v1/search?keyword=test&tax_query[0][taxonomy]=category&tax_query[0][field]=id&tax_query[0][terms]=3&tax_query[0][operator]=NOT IN](http://demo.erlycoder.com/demo1/wp-json/relevanssi/v1/search?keyword=test&tax_query[0][taxonomy]=category&tax_query[0][field]=id&tax_query[0][terms]=3&tax_query[0][operator]=NOT IN)

各版本下載點

  • 方法一：點下方版本號的連結下載 ZIP 檔案後，登入網站後台左側選單「外掛」的「安裝外掛」，然後選擇上方的「上傳外掛」，把下載回去的 ZIP 外掛打包檔案上傳上去安裝與啟用。
  • 方法二：透過「安裝外掛」的畫面右方搜尋功能，搜尋外掛名稱「REST API for Relevanssi」來進行安裝。

（建議使用方法二，確保安裝的版本符合當前運作的 WordPress 環境。

最新版本

延伸相關外掛（你可能也想知道）

  • Autocomplete For Relevanssi 》這個外掛旨在通過使用存儲在Relevanssi數據庫中的索引，在搜索輸入欄位中添加單詞自動完成功能。因此，在使用它之前，您必須先安裝Relevanssi（免費或付費版...。
  • Ajax Load More for Relevanssi 》Ajax Load More for Relevanssi 是一個小型的擴充功能，可提供返回 Relevanssi 查詢結果至 Ajax Load More 進行無限滾動的功能。, 此外採用提供 Ajax Load Mo...。
  • Relevanssi Dashboard 》用於 Relevanssi 搜尋數據的儀表板小工具。當然需要與精彩的 Relevanssi 外掛一起使用。。
  • Step Index For relevanssi 》Relevanssi 現在已經內建這項功能。請升級您的 Relevanssi 並移除這個外掛。, Relevanssi 有著逐步建立索引的功能（預設每次建立 500 篇文章）。但是，如果您...。
  • PageApp 》這是針對 PageApp 行動框架的 WordPress wp-json 擴充套件：, * 為 rest api 建立可以白名單的 meta 值, * 透過 rest api 啟用 Relevanssi。
  • Suggestion Toolkit – Youtube 》這個外掛是針對 WordPress 的Suggestion Toolkit的擴充功能。它允許您在 WordPress 網誌或網站中，將 YouTube 影片建議納入建議區塊中。, 建議包括設置數量的...。
  • Suggestion Toolkit 》本外掛提供一種快速靈活的方法，在WordPress網站頁面上添加不同類型的推薦內容，幾乎可以在網站的任何地方插入。它提供了Gutenberg塊、Elementor小工具、短碼...。

文章
Filter
Apply Filters
Close
Mastodon