aboutsummaryrefslogtreecommitdiffstats
path: root/README.hooks
blob: d15949c79611caa0d3b4433e3cb98a98adf7b2ec (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Hooks that plugins can provide

All hooks must return either undefined/null or a list of return values. This might be an empty list or a list of just one value.

handlePath
  Registers new urls to serve
  Parameters: None
  Returns: Parameter suitable for Dispatcher
renderPageBodyPre
  Adds extra html before the body of a page
  Parameters: bodyFileName, data, plugin
  Returns: String(s) of html
renderPageBodyPost
  Adds extra html after the body of a page
  Parameters: bodyFileName, data, plugin
  Returns: String(s) of html
serverStartup
  Run right after server startup
  Parameters: None
  Returns: None
serverShutdown
  Run before server shutdown
  Parameters: None
  Returns: None