docs/dev/plugins.rst · searx

on 4b4e95f help sign in

searx/docs/dev/plugins.rst

54 lines 1.3 kB history raw

1.. _dev plugin:

3=======

4Plugins

5=======

7.. sidebar:: Further reading ..

9 - :ref:`plugins generic`

11Plugins can extend or replace functionality of various components of searx.

13Example plugin

14==============

16.. code:: python

18 name = 'Example plugin'

19 description = 'This plugin extends the suggestions with the word "example"'

20 default_on = False # disabled by default

22 js_dependencies = tuple() # optional, list of static js files

23 css_dependencies = tuple() # optional, list of static css files

26 # attach callback to the post search hook

27 # request: flask request object

28 # ctx: the whole local context of the post search hook

29 def post_search(request, ctx):

30 ctx['search'].suggestions.add('example')

31 return True

33Plugin entry points

34===================

36Entry points (hooks) define when a plugin runs. Right now only three hooks are

37implemented. So feel free to implement a hook if it fits the behaviour of your

38plugin.

40Pre search hook

41---------------

43Runs BEFORE the search request. Function to implement: ``pre_search``

45Post search hook

46----------------

48Runs AFTER the search request. Function to implement: ``post_search``

50Result hook

51-----------

53Runs when a new result is added to the result list. Function to implement:

54``on_result``