mirror of
https://github.com/searxng/searxng.git
synced 2024-11-18 17:01:01 +00:00
90174e215c
- Plugins configured at built time (defaults) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
1.3 KiB
1.3 KiB
Plugins
Further reading ..
plugins generic
Plugins can extend or replace functionality of various components of searx.
Example plugin
= 'Example plugin'
name = 'This plugin extends the suggestions with the word "example"'
description = False # disabled by default
default_on
= tuple() # optional, list of static js files
js_dependencies = tuple() # optional, list of static css files
css_dependencies
# attach callback to the post search hook
# request: flask request object
# ctx: the whole local context of the post search hook
def post_search(request, ctx):
'search'].suggestions.add('example')
ctx[return True
Plugin entry points
Entry points (hooks) define when a plugin runs. Right now only three hooks are implemented. So feel free to implement a hook if it fits the behaviour of your plugin.
Pre search hook
Runs BEFORE the search request. Function to implement: pre_search
Post search hook
Runs AFTER the search request. Function to implement: post_search
Result hook
Runs when a new result is added to the result list. Function to implement: on_result