# FluentBoards Filter Hooks

FluentBoards Core Intermediate

FluentBoards has many interesting filer hooks that let developers change default settings and even extend FluentBoards with new functionality.

# What are Filter Hooks

A hook is a feature that allows developers to manipulate functionality without modifying core files. A hook can help developers inject some functions or edit default settings.

Filter hooks are used to return modified values for certain parameters, based on different factors.

# Available Filter Hooks

# fluent_boards/board_find

When you find a board it returns a board object. But if you want to manipulate that board data and return modified board object then you can use this filter.

Parameters

$board Object

Usage:

/*
* Manipulate board object
*/
add_filter('fluent_boards/board_find', function($board) {
   return $board;
});

1
2
3
4
5
6

# fluent_boards/before_create_board

But if you want to modify board data before create that board then you can use this filter.

Parameters

$boardData Object

Usage:

/*
* Manipulate board data before task create
*/
add_filter('fluent_boards/before_create_board', function($boardData) {
   return $boardData;
});

1
2
3
4
5
6

# fluent_boards/before_task_create

But if you want to modify task data before create that task then you can use this filter.

Parameters

$data Object

Usage:

/*
* Manipulate task data before task create
*/
add_filter('fluent_boards/before_task_create', function($data) {
   return $data;
});

1
2
3
4
5
6

# fluent_boards/uploaded_file_name_prefix

But if you want to modify uploaded file name prefix then you can use this filter.

Parameters

$prefix String

Usage:

/*
* Modify uploaded file name prefix
*/
add_filter('fluent_boards/uploaded_file_name_prefix', function($prefix) {
   return $prefix;
});

1
2
3
4
5
6

# fluent_boards/incoming_webhook_data

But if you want to modify incoming webhook data then you can use this filter.

Parameters

$postData Array
$webhook String

Usage:

/*
* Modify incoming webhook data
*/
add_filter('fluent_boards/incoming_webhook_data', function($postData, $webhook) {
   return $postData;
});

1
2
3
4
5
6

# fluent_boards/webhook_task_data

But if you want to modify webhook task data then you can use this filter.

Parameters

$postData Array
$webhook String

Usage:

/*
* Modify webhook task data
*/
add_filter('fluent_boards/webhook_task_data', function($postData, $webhook) {
   return $postData;
});

1
2
3
4
5
6

# fluent_boards/site_logo

But if you want to change site logo then you can use this filter.

Parameters

$logo_url String

Usage:

/*
* Change site logo
*/
add_filter('fluent_boards/site_logo', function($logo_url) {
   return $logo_url;
});

1
2
3
4
5
6

# fluent_boards/addons_settings

But if you want to modify addon data in features and module settings then you can use this filter.

Parameters

$addOns Array

Usage:

/*
* Modify addon data in features and module settings
*/
add_filter('fluent_boards/addons_settings', function($addOns) {
   return $addOns;
});

1
2
3
4
5
6

# fluent_boards/accepted_plugins

But if you want to modify accepted free plugins then you can use this filter.

Parameters

$acceptedFreePlugins Array

Usage:

/*
* Modify accepted free plugins
*/
add_filter('fluent_boards/accepted_plugins', function($acceptedFreePlugins) {
   return $acceptedFreePlugins;
});

1
2
3
4
5
6

# fluent_boards/save_general_settings

But if you want to modify general settings before save then you can use this filter.

Parameters

$settings Array

Usage:

/*
* Modify general settings before save
*/
add_filter('fluent_boards/save_general_settings', function($settings) {
   return $settings;
});

1
2
3
4
5
6

# fluent_boards/email_footer

But if you want to modify email footer then you can use this filter.

Parameters

$footer_text String

Usage:

/*
* Modify email footer
*/
add_filter('fluent_boards/email_footer', function($footer_text) {
   return $footer_text;
});

1
2
3
4
5
6

# fluent_boards/email_header

But if you want to modify email header then you can use this filter.

Parameters

$email_header String

Usage:

/*
* Modify email header
*/
add_filter('fluent_boards/email_header', function($email_header) {
   return $email_header;
});

1
2
3
4
5
6

# fluent_boards/task_priorities

If you want to modify task priorities then you can use this filter.

Parameters

$priorities Array - 'high', 'medium', 'low'

Usage:

/*
* Modify task priorities
*/
add_filter('fluent_boards/task_priorities', function($priorities) {
    $priorities['urgent'] = __('Urgent', 'fluent-boards');
    return $priorities;
});

1
2
3
4
5
6
7

# fluent_boards/task_tabs

If you want to modify the order of activity, comment log in task modal then you can use this filter.

Parameters

$tabs Array - 'all', 'comment', 'activity'

Usage:

/*
* Modify task tabs
*/
add_filter('fluent_boards/task_tabs', function($tabs) {
    $reorderedTabs = [
        'activity' => $tabs['activity'], //1st 
        'comment' => $tabs['comment'], //2nd
        'all' => $tabs['all'], //3rd  
    ];
    
    return $reorderedTabs;
});

1
2
3
4
5
6
7
8
9
10
11
12

# fluent_boards/board_menu_items

Modify board menu items. This filter runs when the board menu is loaded and allows you to customize the sidebar menu that appears on the right side of the board.

Parameters

$menuItems Array - Array of existing menu items with their properties (key, label, type, position, etc.)
$board_id Integer - The current board ID

Menu Item Structure:

[
    'key' => 'unique_identifier',        // Required: Unique key for the menu item
    'label' => 'Menu Label',             // Required: Display text
    'type' => 'default|custom',          // Required: Item type
    'position' => 13,                    // Optional: Position in menu (lower = higher)
    'icon' => '<svg>...</svg>',          // Required for custom items: SVG icon HTML
    'html' => '<div>Content</div>',      // Required for custom items: HTML content
    'width' => '500px',                  // Optional: Modal/drawer width
    'render_in' => 'drawer|modal',       // Optional: 'drawer' (default) or 'modal' to open as popup modal
    'role' => 'manager|admin'            // Optional: Required user role
]

1
2
3
4
5
6
7
8
9
10
11

Usage:

/*
* Modify board menu items
*/
add_filter('fluent_boards/board_menu_items', function($menuItems, $board_id) {
   // Add custom menu item (will open in drawer by default)
   $menuItems['my_custom_item'] = [
       'key' => 'my_custom_item',
       'label' => 'My Custom Item',
       'type' => 'custom',
       'position' => 13,
       'icon' => '<svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a7 7 0 100 14A7 7 0 008 1zM3.5 8a4.5 4.5 0 119 0 4.5 4.5 0 01-9 0z"/></svg>',
       'html' => '<div>Custom content</div>', // Required for custom items
       'width' => '500px',
       'render_in' => 'drawer' // or 'modal' for popup modal
   ];
   
   return $menuItems;
}, 10, 2);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# fluent_boards/menu_items

If you want to modify the menu items ( add new menu or remove/replace existing ones) in FluentBoards, you can use this filter.

Parameters

$menuItems Array

Usage:

/*
* Modify menu items
*/
add_filter('fluent_boards/menu_items', function($menuItems) {
   // your modification logic here

   return $menuItems;
});

1
2
3
4
5
6
7
8

Edit this page on GitHub (opens new window)

Last Updated: 7/30/2025, 6:11:33 AM

← Actions