DE EN

Event Filter Module

Complete Documentation

Back to Overview

Intelligently Filter Events on Individual Pages

The Event Filter Module allows you to selectively filter events on individual pages. With intelligent OR logic, automatic type detection and localStorage persistence.

Quick Start – Get Started Immediately!

  1. Download module: Get ZIP file from the homepage
  2. Upload: Extract to /modules_v4/wt-event-filter/
  3. Enable: In Webtrees under "Control panel → Modules → All modules"
  4. Use: Open an individual page – the filter bar appears automatically!
Event Filter Module - Filter View
Client-side

No server reload

Automatic

Only existing types

Persistent

Selection is saved

1 Download Module

Download the ZIP archive from the homepage and extract it.

2 Upload Files

Upload the wt-event-filter folder to the /modules_v4/ directory of your Webtrees installation.

The structure should be:
webtrees/modules_v4/wt-event-filter/module.php
3 Enable Module
  1. Log in as administrator to Webtrees
  2. Go to Control panel → Modules → All modules
  3. Search for "WT Event Filter"
  4. Enable the module by clicking the switch
Done! The module is immediately ready to use – no further configuration needed!

Basic Usage
  1. Open an individual page in Webtrees
  2. A filter bar automatically appears above the events list
  3. Select one or more event types by clicking them
  4. The events list is immediately filtered
  5. Click "Clear all" to reset the filter
Understanding Filter Logic
Example 1 - No selection:
✓ All events are displayed
Example 2 - One selection (e.g., "Birth"):
✓ Only birth events are displayed
✗ All other events are hidden
Example 3 - Multiple selections (e.g., "Occupation" + "Education"):
✓ All occupation events are displayed
✓ All education events are displayed
✗ All other events are hidden
→ OR connection: Shows events matching ANY of the filters
Persistence (Storage)
Automatic saving: Your filter selection is saved per person. When you visit the same individual page later, your previous selection is restored.
Compatibility

The module works with:

  • ✓ Standard Webtrees "Facts and events" tab
  • ✓ Vesta Facts and events module
  • ✓ All common themes

Filter Doesn't Appear
Checklist:
  1. Is the module enabled? → "Control panel → Modules → All modules"
  2. Is JavaScript enabled in the browser?
  3. Does the individual page have events?
  4. Check browser console (F12) for error messages
Filter Doesn't Work with My Theme

The module uses configurable DOM selectors. If you have problems:

  1. Open the browser console (F12)
  2. Look for warnings like "Could not find facts tab container"
  3. Contact support with screenshots of the errors
Filter Selection Not Saved
The module uses localStorage. Make sure that:
  • The browser supports localStorage (all modern browsers do)
  • No browser extensions block localStorage
  • The browser is not in private/incognito mode
  • Cookies and site data are not deleted after each close
Events Are Not Filtered
Possible causes:
  • JavaScript error → Check browser console (F12)
  • Theme incompatibility → Contact support
  • Another module causing conflict → Test by temporarily disabling other modules

Technical Properties
  • Client-side: Complete filtering runs in the browser, no server requests
  • Performance: Debouncing (75ms) for large event lists
  • No dependencies: Pure JavaScript, no jQuery required
  • Defensive programming: Works even with DOM deviations
  • Accessible: Proper labels, keyboard navigation, ARIA attributes
Customizing DOM Selectors

If the module doesn't work with your theme, you can customize the DOM selectors:

The selectors are located in:
/modules_v4/wt-event-filter/resources/js/filter.js
Contact support for help with customizations.
Supported Languages

The module is multilingual and supports:

🇩🇪 German
🇬🇧 English
🇫🇷 French
🇭🇺 Hungarian
System Requirements
Webtrees: Version 2.2.1 or higher (tested with 2.2.4)
PHP: Version 8.0 or higher (recommended: 8.3+)
Browser: All modern browsers with JavaScript enabled

License

This module is free software and is published under the GNU General Public License v3.0.

webtrees: online genealogy
Copyright (C) 2025 webtrees development team

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

The complete license can be found at: https://www.gnu.org/licenses/gpl-3.0.html

Support

For questions or problems:

Useful Links
Back to Overview