Descripción
This plugin provides simple REST API for the popular search WordPress search engine – Relevanssi.
As far as this plugin provides API for Relevanssi plugin, it should be installed.
Key features
- Search through the posts of certain type. By default all types.
- Results pagination and optional.
- Sets X-WP-Total header with total number of records, same way as default search api does.
- Sets X-WP-TotalPages header with total number of pages, same way as 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 problem.
- Taxonomy filters are supported now. Some features may be missed, so feel free to report.
- 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 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 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)
Instalación
- Ensure that Relevanssi plugin is installed
- Login to the admin area of your WordPress website.
- Go to “Plugins” section.
- Click “Add new” and search for “REST API for Relevanssi”.
- Install plugin.
Alternative way #1
- Ensure that Relevanssi plugin is installed
- Download REST API for Relevanssi plugin from the WordPress plugin diretcory.
- Go to Plugins > Add New > Upload and select the ZIP file you just downloaded.Click Install Now, and then Activate.
- Activate the plugin through the ‘Plugins’ screen in WordPress
- Plugin does not require any further configuration
Alternative way #2
- Ensure that Relevanssi plugin is installed
- Download REST API for Relevanssi plugin from the WordPress plugin diretcory.
- Upload the plugin files to the
/wp-content/plugins/relevanssi-rest-apidirectory, or install the plugin through the WordPress plugins screen directly. - Activate the plugin through the ‘Plugins’ screen in WordPress
- Plugin does not require any further configuration
Preguntas frecuentes
-
Knowledge base
-
You can find answers and solutions in our Knowledge base.
-
Can I suggest a feature or report a bug?
-
Yes, you can submit your request on our Contact page.
Reseñas
Colaboradores y desarrolladores
Este software es de código abierto. Las siguientes personas han contribuido a este plugin.
Colaboradores
Traduce "REST API for Relevanssi" a tu idioma.
¿Interesado en el desarrollo?
Revisa el código, echa un vistazo al repositorio SVN o suscríbete al registro de desarrollo por RSS.
Registro de cambios
1.14
- Minor fix in post type handling.
- WPML & Polylang compatibility fixes.
1.12
- Minor fix in post type handling.
1.11
- Fixed issues with type=any parameter.
- Fixed issues with multitype requests (Example: type=post,page).
- Default search type is changed to ‘any’. Be carefull updating the plugin.
1.10
- Fixed bug “Call to undefined function is_plugin_active()”.
1.9
- We decided to remove strict requirement for Relevanssi plugin to be installed before API plugin. Instead API will return error if Relevanssi is not installed.
1.8
- Added “page” and “per_page” parameters. Old ones “page” and “per_page” are still supported, but we strongly recommend to to use new ones.
1.7
- Maintenance release.
1.6
- Fixed taxonomy requests.
- One more example added
1.5
- Multilingual websites support (WPML & Polylang).
- Taxonomy filters.
- Search results ordering.
1.0
- Release