From 4ffaba2ba0dd6b5810adea1916080c3b645f3d29 Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Sat, 13 Aug 2016 14:23:53 -0400
Subject: Add reference hooks

---
 doc/plugin-hooks.markdown | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'doc')

diff --git a/doc/plugin-hooks.markdown b/doc/plugin-hooks.markdown
index 787c62df..5e01e93a 100644
--- a/doc/plugin-hooks.markdown
+++ b/doc/plugin-hooks.markdown
@@ -115,6 +115,31 @@ List of asset Hooks:
 - `template:layout:css`
 - `template:layout:js`
 
+
+Reference hooks
+---------------
+
+Reference hooks are passing a variable by reference.
+
+Example:
+
+```php
+$this->hook->on('formatter:board:query', function (\PicoDb\Table &query) {
+    $query->eq('color_id', 'red');
+});
+```
+
+The code above will show only tasks in red on the board.
+
+List of reference hooks:
+
+| Hook                                       | Description                                                   |
+|--------------------------------------------|---------------------------------------------------------------|
+| `formatter:board:query`                    | Alter database query before rendering board                   |
+| `pagination:dashboard:task:query`          | Alter database query for tasks pagination on the dashboard    |
+| `pagination:dashboard:subtask:query`       | Alter database query for subtasks pagination on the dashboard |
+
+
 Template Hooks
 --------------
 
-- 
cgit v1.2.3