webtrees/example-module

Example module for webtrees

Installs: 10

Dependents: 0

Suggesters: 0

Security: 0

Type:webtrees-module

pkg:composer/webtrees/example-module

1.0.0 2026-02-03 00:00 UTC

This package is auto-updated.

Last update: 2026-02-03 01:42:44 UTC


README

This example shows how to create a custom module.

All the functions are optional - edit the ones you need, and delete those that you do not need.

For example, the functions regarding versions, author, support, etc. are only relevant for modules that you intend to share publicly.

This module does not actually do anything. Look at the other examples to see how to add or change specific features.

How to extend/modify an existing modules

This example creates a new module from scratch (by extending AbstractModule).

Advanced: How to install published modules in a development environment.

If a module is published on packagist, you can install it into a development build of webtrees.

This module is published here. You can install it with these commands. Grant permission to composer/installers when asked.

composer require composer/installers
composer require webtrees/example-module